diff --git a/swaggerci/automation/.gitattributes b/swaggerci/automation/.gitattributes new file mode 100644 index 000000000000..2125666142eb --- /dev/null +++ b/swaggerci/automation/.gitattributes @@ -0,0 +1 @@ +* text=auto \ No newline at end of file diff --git a/swaggerci/automation/.gitignore b/swaggerci/automation/.gitignore new file mode 100644 index 000000000000..3c3d57339c8b --- /dev/null +++ b/swaggerci/automation/.gitignore @@ -0,0 +1,16 @@ +bin +obj +.vs +generated +internal +exports +tools +custom/*.psm1 +custom/autogen-model-cmdlets +test/*-TestResults.xml +/*.ps1 +/*.ps1xml +/*.psm1 +/*.snk +/*.csproj +/*.nuspec \ No newline at end of file diff --git a/swaggerci/automation/Az.Automation.psd1 b/swaggerci/automation/Az.Automation.psd1 new file mode 100644 index 000000000000..daa3cfdaddae --- /dev/null +++ b/swaggerci/automation/Az.Automation.psd1 @@ -0,0 +1,24 @@ +@{ + GUID = 'ec8ac03f-3455-4a39-aefc-bada849728d2' + RootModule = './Az.Automation.psm1' + ModuleVersion = '0.1.0' + CompatiblePSEditions = 'Core', 'Desktop' + Author = 'Microsoft Corporation' + CompanyName = 'Microsoft Corporation' + Copyright = 'Microsoft Corporation. All rights reserved.' + Description = 'Microsoft Azure PowerShell: Automation cmdlets' + PowerShellVersion = '5.1' + DotNetFrameworkVersion = '4.7.2' + RequiredAssemblies = './bin/Az.Automation.private.dll' + FormatsToProcess = './Az.Automation.format.ps1xml' + FunctionsToExport = 'Convert-AzAutomationGraphRunbookContent', 'Get-AzAutomationAccount', 'Get-AzAutomationActivity', 'Get-AzAutomationAgentRegistrationInformation', 'Get-AzAutomationCertificate', 'Get-AzAutomationConnection', 'Get-AzAutomationConnectionType', 'Get-AzAutomationCredential', 'Get-AzAutomationDscCompilationJob', 'Get-AzAutomationDscCompilationJobStream', 'Get-AzAutomationDscConfiguration', 'Get-AzAutomationDscConfigurationContent', 'Get-AzAutomationDscNode', 'Get-AzAutomationDscNodeConfiguration', 'Get-AzAutomationField', 'Get-AzAutomationHybridRunbookWorker', 'Get-AzAutomationHybridRunbookWorkerGroup', 'Get-AzAutomationJob', 'Get-AzAutomationJobOutput', 'Get-AzAutomationJobRunbookContent', 'Get-AzAutomationJobSchedule', 'Get-AzAutomationJobStream', 'Get-AzAutomationKey', 'Get-AzAutomationLinkedWorkspace', 'Get-AzAutomationModule', 'Get-AzAutomationNodeCountInformation', 'Get-AzAutomationNodeReport', 'Get-AzAutomationNodeReportContent', 'Get-AzAutomationObjectDataTypeField', 'Get-AzAutomationPrivateEndpointConnection', 'Get-AzAutomationPython2Package', 'Get-AzAutomationRunbook', 'Get-AzAutomationRunbookContent', 'Get-AzAutomationRunbookDraft', 'Get-AzAutomationRunbookDraftContent', 'Get-AzAutomationSchedule', 'Get-AzAutomationSoftwareUpdateConfiguration', 'Get-AzAutomationSoftwareUpdateConfigurationMachineRun', 'Get-AzAutomationSoftwareUpdateConfigurationRun', 'Get-AzAutomationSourceControl', 'Get-AzAutomationSourceControlSyncJob', 'Get-AzAutomationSourceControlSyncJobStream', 'Get-AzAutomationStatistics', 'Get-AzAutomationTestJob', 'Get-AzAutomationTestJobStream', 'Get-AzAutomationUsage', 'Get-AzAutomationVariable', 'Get-AzAutomationWatcher', 'Get-AzAutomationWebhook', 'Invoke-AzAutomationPrivateLinkResource', 'Move-AzAutomationHybridRunbookWorker', 'New-AzAutomationAccount', 'New-AzAutomationAgentRegistrationInformationKey', 'New-AzAutomationCertificate', 'New-AzAutomationConnection', 'New-AzAutomationConnectionType', 'New-AzAutomationCredential', 'New-AzAutomationDscCompilationJob', 'New-AzAutomationDscNodeConfiguration', 'New-AzAutomationHybridRunbookWorker', 'New-AzAutomationHybridRunbookWorkerGroup', 'New-AzAutomationJob', 'New-AzAutomationJobSchedule', 'New-AzAutomationModule', 'New-AzAutomationPrivateEndpointConnection', 'New-AzAutomationPython2Package', 'New-AzAutomationRunbook', 'New-AzAutomationSchedule', 'New-AzAutomationSoftwareUpdateConfiguration', 'New-AzAutomationSourceControl', 'New-AzAutomationSourceControlSyncJob', 'New-AzAutomationTestJob', 'New-AzAutomationVariable', 'New-AzAutomationWatcher', 'New-AzAutomationWebhook', 'New-AzAutomationWebhookUri', 'Publish-AzAutomationRunbook', 'Remove-AzAutomationAccount', 'Remove-AzAutomationCertificate', 'Remove-AzAutomationConnection', 'Remove-AzAutomationConnectionType', 'Remove-AzAutomationCredential', 'Remove-AzAutomationDscConfiguration', 'Remove-AzAutomationDscNode', 'Remove-AzAutomationDscNodeConfiguration', 'Remove-AzAutomationHybridRunbookWorker', 'Remove-AzAutomationHybridRunbookWorkerGroup', 'Remove-AzAutomationJobSchedule', 'Remove-AzAutomationModule', 'Remove-AzAutomationPrivateEndpointConnection', 'Remove-AzAutomationPython2Package', 'Remove-AzAutomationRunbook', 'Remove-AzAutomationSchedule', 'Remove-AzAutomationSoftwareUpdateConfiguration', 'Remove-AzAutomationSourceControl', 'Remove-AzAutomationVariable', 'Remove-AzAutomationWatcher', 'Remove-AzAutomationWebhook', 'Resume-AzAutomationJob', 'Resume-AzAutomationTestJob', 'Start-AzAutomationWatcher', 'Stop-AzAutomationJob', 'Stop-AzAutomationTestJob', 'Stop-AzAutomationWatcher', 'Suspend-AzAutomationJob', 'Suspend-AzAutomationTestJob', 'Undo-AzAutomationRunbookDraftEdit', 'Update-AzAutomationAccount', 'Update-AzAutomationCertificate', 'Update-AzAutomationConnection', 'Update-AzAutomationCredential', 'Update-AzAutomationDscNode', 'Update-AzAutomationHybridRunbookWorkerGroup', 'Update-AzAutomationModule', 'Update-AzAutomationPython2Package', 'Update-AzAutomationRunbook', 'Update-AzAutomationSchedule', 'Update-AzAutomationSourceControl', 'Update-AzAutomationVariable', 'Update-AzAutomationWatcher', 'Update-AzAutomationWebhook', '*' + AliasesToExport = '*' + PrivateData = @{ + PSData = @{ + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'Automation' + LicenseUri = 'https://aka.ms/azps-license' + ProjectUri = 'https://github.com/Azure/azure-powershell' + ReleaseNotes = '' + } + } +} diff --git a/swaggerci/automation/README.md b/swaggerci/automation/README.md new file mode 100644 index 000000000000..fe2e6d2ead5b --- /dev/null +++ b/swaggerci/automation/README.md @@ -0,0 +1,27 @@ + +# Az.Automation +This directory contains the PowerShell module for the Automation service. + +--- +## Status +[![Az.Automation](https://img.shields.io/powershellgallery/v/Az.Automation.svg?style=flat-square&label=Az.Automation "Az.Automation")](https://www.powershellgallery.com/packages/Az.Automation/) + +## Info +- Modifiable: yes +- Generated: all +- Committed: yes +- Packaged: yes + +--- +## Detail +This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension. + +## Module Requirements +- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater + +## Authentication +AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent. + +## Development +For information on how to develop for `Az.Automation`, see [how-to.md](how-to.md). + diff --git a/swaggerci/automation/custom/README.md b/swaggerci/automation/custom/README.md new file mode 100644 index 000000000000..c68c8a41ea02 --- /dev/null +++ b/swaggerci/automation/custom/README.md @@ -0,0 +1,41 @@ +# Custom +This directory contains custom implementation for non-generated cmdlets for the `Az.Automation` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `../exports` folder. The only generated file into this folder is the `Az.Automation.custom.psm1`. This file should not be modified. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: yes + +## Details +For `Az.Automation` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*. + +For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.Automation.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder. + +For script cmdlets, these are loaded via the `Az.Automation.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build. + +## Purpose +This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `../exports` folder. + +## Usage +The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters: +- Break +- DefaultProfile +- HttpPipelineAppend +- HttpPipelinePrepend +- Proxy +- ProxyCredential +- ProxyUseDefaultCredentials + +These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Az.Automation`. For C#, follow the usage seen in the `ProcessRecordAsync` method. + +### Attributes +For processing the cmdlets, we've created some additional attributes: +- `Microsoft.Azure.PowerShell.Cmdlets.Automation.DescriptionAttribute` + - Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts. +- `Microsoft.Azure.PowerShell.Cmdlets.Automation.DoNotExportAttribute` + - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.Automation`. +- `Microsoft.Azure.PowerShell.Cmdlets.Automation.InternalExportAttribute` + - Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.Automation`. For more information, see [README.md](../internal/README.md) in the `../internal` folder. +- `Microsoft.Azure.PowerShell.Cmdlets.Automation.ProfileAttribute` + - Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules. \ No newline at end of file diff --git a/swaggerci/automation/docs/Az.Automation.md b/swaggerci/automation/docs/Az.Automation.md new file mode 100644 index 000000000000..76d8cbadc94f --- /dev/null +++ b/swaggerci/automation/docs/Az.Automation.md @@ -0,0 +1,376 @@ +--- +Module Name: Az.Automation +Module Guid: ec8ac03f-3455-4a39-aefc-bada849728d2 +Download Help Link: https://docs.microsoft.com/en-us/powershell/module/az.automation +Help Version: 1.0.0.0 +Locale: en-US +--- + +# Az.Automation Module +## Description +Microsoft Azure PowerShell: Automation cmdlets + +## Az.Automation Cmdlets +### [Convert-AzAutomationGraphRunbookContent](Convert-AzAutomationGraphRunbookContent.md) +Post operation to serialize or deserialize GraphRunbookContent + +### [Get-AzAutomationAccount](Get-AzAutomationAccount.md) +Get information about an Automation Account. + +### [Get-AzAutomationActivity](Get-AzAutomationActivity.md) +Retrieve the activity in the module identified by module name and activity name. + +### [Get-AzAutomationAgentRegistrationInformation](Get-AzAutomationAgentRegistrationInformation.md) +Retrieve the automation agent registration information. + +### [Get-AzAutomationCertificate](Get-AzAutomationCertificate.md) +Retrieve the certificate identified by certificate name. + +### [Get-AzAutomationConnection](Get-AzAutomationConnection.md) +Retrieve the connection identified by connection name. + +### [Get-AzAutomationConnectionType](Get-AzAutomationConnectionType.md) +Retrieve the connection type identified by connection type name. + +### [Get-AzAutomationCredential](Get-AzAutomationCredential.md) +Retrieve the credential identified by credential name. + +### [Get-AzAutomationDscCompilationJob](Get-AzAutomationDscCompilationJob.md) +Retrieve the Dsc configuration compilation job identified by job id. + +### [Get-AzAutomationDscCompilationJobStream](Get-AzAutomationDscCompilationJobStream.md) +Retrieve the job stream identified by job stream id. + +### [Get-AzAutomationDscConfiguration](Get-AzAutomationDscConfiguration.md) +Retrieve the configuration identified by configuration name. + +### [Get-AzAutomationDscConfigurationContent](Get-AzAutomationDscConfigurationContent.md) +Retrieve the configuration script identified by configuration name. + +### [Get-AzAutomationDscNode](Get-AzAutomationDscNode.md) +Retrieve the dsc node identified by node id. + +### [Get-AzAutomationDscNodeConfiguration](Get-AzAutomationDscNodeConfiguration.md) +Retrieve the Dsc node configurations by node configuration. + +### [Get-AzAutomationField](Get-AzAutomationField.md) +Retrieve a list of fields of a given type identified by module name. + +### [Get-AzAutomationHybridRunbookWorker](Get-AzAutomationHybridRunbookWorker.md) +Retrieve a hybrid runbook worker. + +### [Get-AzAutomationHybridRunbookWorkerGroup](Get-AzAutomationHybridRunbookWorkerGroup.md) +Retrieve a hybrid runbook worker group. + +### [Get-AzAutomationJob](Get-AzAutomationJob.md) +Retrieve the job identified by job name. + +### [Get-AzAutomationJobOutput](Get-AzAutomationJobOutput.md) +Retrieve the job output identified by job name. + +### [Get-AzAutomationJobRunbookContent](Get-AzAutomationJobRunbookContent.md) +Retrieve the runbook content of the job identified by job name. + +### [Get-AzAutomationJobSchedule](Get-AzAutomationJobSchedule.md) +Retrieve the job schedule identified by job schedule name. + +### [Get-AzAutomationJobStream](Get-AzAutomationJobStream.md) +Retrieve the job stream identified by job stream id. + +### [Get-AzAutomationKey](Get-AzAutomationKey.md) +Retrieve the automation keys for an account. + +### [Get-AzAutomationLinkedWorkspace](Get-AzAutomationLinkedWorkspace.md) +Retrieve the linked workspace for the account id. + +### [Get-AzAutomationModule](Get-AzAutomationModule.md) +Retrieve the module identified by module name. + +### [Get-AzAutomationNodeCountInformation](Get-AzAutomationNodeCountInformation.md) +Retrieve counts for Dsc Nodes. + +### [Get-AzAutomationNodeReport](Get-AzAutomationNodeReport.md) +Retrieve the Dsc node report data by node id and report id. + +### [Get-AzAutomationNodeReportContent](Get-AzAutomationNodeReportContent.md) +Retrieve the Dsc node reports by node id and report id. + +### [Get-AzAutomationObjectDataTypeField](Get-AzAutomationObjectDataTypeField.md) +Retrieve a list of fields of a given type identified by module name. + +### [Get-AzAutomationPrivateEndpointConnection](Get-AzAutomationPrivateEndpointConnection.md) +Gets a private endpoint connection. + +### [Get-AzAutomationPython2Package](Get-AzAutomationPython2Package.md) +Retrieve the python 2 package identified by package name. + +### [Get-AzAutomationRunbook](Get-AzAutomationRunbook.md) +Retrieve the runbook identified by runbook name. + +### [Get-AzAutomationRunbookContent](Get-AzAutomationRunbookContent.md) +Retrieve the content of runbook identified by runbook name. + +### [Get-AzAutomationRunbookDraft](Get-AzAutomationRunbookDraft.md) +Retrieve the runbook draft identified by runbook name. + +### [Get-AzAutomationRunbookDraftContent](Get-AzAutomationRunbookDraftContent.md) +Retrieve the content of runbook draft identified by runbook name. + +### [Get-AzAutomationSchedule](Get-AzAutomationSchedule.md) +Retrieve the schedule identified by schedule name. + +### [Get-AzAutomationSoftwareUpdateConfiguration](Get-AzAutomationSoftwareUpdateConfiguration.md) +Get a single software update configuration by name. + +### [Get-AzAutomationSoftwareUpdateConfigurationMachineRun](Get-AzAutomationSoftwareUpdateConfigurationMachineRun.md) +Get a single software update configuration machine run by Id. + +### [Get-AzAutomationSoftwareUpdateConfigurationRun](Get-AzAutomationSoftwareUpdateConfigurationRun.md) +Get a single software update configuration Run by Id. + +### [Get-AzAutomationSourceControl](Get-AzAutomationSourceControl.md) +Retrieve the source control identified by source control name. + +### [Get-AzAutomationSourceControlSyncJob](Get-AzAutomationSourceControlSyncJob.md) +Retrieve the source control sync job identified by job id. + +### [Get-AzAutomationSourceControlSyncJobStream](Get-AzAutomationSourceControlSyncJobStream.md) +Retrieve a sync job stream identified by stream id. + +### [Get-AzAutomationStatistics](Get-AzAutomationStatistics.md) +Retrieve the statistics for the account. + +### [Get-AzAutomationTestJob](Get-AzAutomationTestJob.md) +Retrieve the test job for the specified runbook. + +### [Get-AzAutomationTestJobStream](Get-AzAutomationTestJobStream.md) +Retrieve a test job stream of the test job identified by runbook name and stream id. + +### [Get-AzAutomationUsage](Get-AzAutomationUsage.md) +Retrieve the usage for the account id. + +### [Get-AzAutomationVariable](Get-AzAutomationVariable.md) +Retrieve the variable identified by variable name. + +### [Get-AzAutomationWatcher](Get-AzAutomationWatcher.md) +Retrieve the watcher identified by watcher name. + +### [Get-AzAutomationWebhook](Get-AzAutomationWebhook.md) +Retrieve the webhook identified by webhook name. + +### [Invoke-AzAutomationPrivateLinkResource](Invoke-AzAutomationPrivateLinkResource.md) +Gets the private link resources that need to be created for Automation account. + +### [Move-AzAutomationHybridRunbookWorker](Move-AzAutomationHybridRunbookWorker.md) +Move a hybrid worker to a different group. + +### [New-AzAutomationAccount](New-AzAutomationAccount.md) +Create or update automation account. + +### [New-AzAutomationAgentRegistrationInformationKey](New-AzAutomationAgentRegistrationInformationKey.md) +Regenerate a primary or secondary agent registration key + +### [New-AzAutomationCertificate](New-AzAutomationCertificate.md) +Create a certificate. + +### [New-AzAutomationConnection](New-AzAutomationConnection.md) +Create or update a connection. + +### [New-AzAutomationConnectionType](New-AzAutomationConnectionType.md) +Create a connection type. + +### [New-AzAutomationCredential](New-AzAutomationCredential.md) +Create a credential. + +### [New-AzAutomationDscCompilationJob](New-AzAutomationDscCompilationJob.md) +Creates the Dsc compilation job of the configuration. + +### [New-AzAutomationDscNodeConfiguration](New-AzAutomationDscNodeConfiguration.md) +Create the node configuration identified by node configuration name. + +### [New-AzAutomationHybridRunbookWorker](New-AzAutomationHybridRunbookWorker.md) +Create a hybrid runbook worker. + +### [New-AzAutomationHybridRunbookWorkerGroup](New-AzAutomationHybridRunbookWorkerGroup.md) +Create a hybrid runbook worker group. + +### [New-AzAutomationJob](New-AzAutomationJob.md) +Create a job of the runbook. + +### [New-AzAutomationJobSchedule](New-AzAutomationJobSchedule.md) +Create a job schedule. + +### [New-AzAutomationModule](New-AzAutomationModule.md) +Create or Update the module identified by module name. + +### [New-AzAutomationPrivateEndpointConnection](New-AzAutomationPrivateEndpointConnection.md) +Approve or reject a private endpoint connection with a given name. + +### [New-AzAutomationPython2Package](New-AzAutomationPython2Package.md) +Create or Update the python 2 package identified by package name. + +### [New-AzAutomationRunbook](New-AzAutomationRunbook.md) +Create the runbook identified by runbook name. + +### [New-AzAutomationSchedule](New-AzAutomationSchedule.md) +Create a schedule. + +### [New-AzAutomationSoftwareUpdateConfiguration](New-AzAutomationSoftwareUpdateConfiguration.md) +Create a new software update configuration with the name given in the URI. + +### [New-AzAutomationSourceControl](New-AzAutomationSourceControl.md) +Create a source control. + +### [New-AzAutomationSourceControlSyncJob](New-AzAutomationSourceControlSyncJob.md) +Creates the sync job for a source control. + +### [New-AzAutomationTestJob](New-AzAutomationTestJob.md) +Create a test job of the runbook. + +### [New-AzAutomationVariable](New-AzAutomationVariable.md) +Create a variable. + +### [New-AzAutomationWatcher](New-AzAutomationWatcher.md) +Create the watcher identified by watcher name. + +### [New-AzAutomationWebhook](New-AzAutomationWebhook.md) +Create the webhook identified by webhook name. + +### [New-AzAutomationWebhookUri](New-AzAutomationWebhookUri.md) +Generates a Uri for use in creating a webhook. + +### [Publish-AzAutomationRunbook](Publish-AzAutomationRunbook.md) +Publish runbook draft. + +### [Remove-AzAutomationAccount](Remove-AzAutomationAccount.md) +Delete an automation account. + +### [Remove-AzAutomationCertificate](Remove-AzAutomationCertificate.md) +Delete the certificate. + +### [Remove-AzAutomationConnection](Remove-AzAutomationConnection.md) +Delete the connection. + +### [Remove-AzAutomationConnectionType](Remove-AzAutomationConnectionType.md) +Delete the connection type. + +### [Remove-AzAutomationCredential](Remove-AzAutomationCredential.md) +Delete the credential. + +### [Remove-AzAutomationDscConfiguration](Remove-AzAutomationDscConfiguration.md) +Delete the dsc configuration identified by configuration name. + +### [Remove-AzAutomationDscNode](Remove-AzAutomationDscNode.md) +Delete the dsc node identified by node id. + +### [Remove-AzAutomationDscNodeConfiguration](Remove-AzAutomationDscNodeConfiguration.md) +Delete the Dsc node configurations by node configuration. + +### [Remove-AzAutomationHybridRunbookWorker](Remove-AzAutomationHybridRunbookWorker.md) +Delete a hybrid runbook worker. + +### [Remove-AzAutomationHybridRunbookWorkerGroup](Remove-AzAutomationHybridRunbookWorkerGroup.md) +Delete a hybrid runbook worker group. + +### [Remove-AzAutomationJobSchedule](Remove-AzAutomationJobSchedule.md) +Delete the job schedule identified by job schedule name. + +### [Remove-AzAutomationModule](Remove-AzAutomationModule.md) +Delete the module by name. + +### [Remove-AzAutomationPrivateEndpointConnection](Remove-AzAutomationPrivateEndpointConnection.md) +Deletes a private endpoint connection with a given name. + +### [Remove-AzAutomationPython2Package](Remove-AzAutomationPython2Package.md) +Delete the python 2 package by name. + +### [Remove-AzAutomationRunbook](Remove-AzAutomationRunbook.md) +Delete the runbook by name. + +### [Remove-AzAutomationSchedule](Remove-AzAutomationSchedule.md) +Delete the schedule identified by schedule name. + +### [Remove-AzAutomationSoftwareUpdateConfiguration](Remove-AzAutomationSoftwareUpdateConfiguration.md) +delete a specific software update configuration. + +### [Remove-AzAutomationSourceControl](Remove-AzAutomationSourceControl.md) +Delete the source control. + +### [Remove-AzAutomationVariable](Remove-AzAutomationVariable.md) +Delete the variable. + +### [Remove-AzAutomationWatcher](Remove-AzAutomationWatcher.md) +Delete the watcher by name. + +### [Remove-AzAutomationWebhook](Remove-AzAutomationWebhook.md) +Delete the webhook by name. + +### [Resume-AzAutomationJob](Resume-AzAutomationJob.md) +Resume the job identified by jobName. + +### [Resume-AzAutomationTestJob](Resume-AzAutomationTestJob.md) +Resume the test job. + +### [Start-AzAutomationWatcher](Start-AzAutomationWatcher.md) +Resume the watcher identified by watcher name. + +### [Stop-AzAutomationJob](Stop-AzAutomationJob.md) +Stop the job identified by jobName. + +### [Stop-AzAutomationTestJob](Stop-AzAutomationTestJob.md) +Stop the test job. + +### [Stop-AzAutomationWatcher](Stop-AzAutomationWatcher.md) +Resume the watcher identified by watcher name. + +### [Suspend-AzAutomationJob](Suspend-AzAutomationJob.md) +Suspend the job identified by job name. + +### [Suspend-AzAutomationTestJob](Suspend-AzAutomationTestJob.md) +Suspend the test job. + +### [Undo-AzAutomationRunbookDraftEdit](Undo-AzAutomationRunbookDraftEdit.md) +Undo draft edit to last known published state identified by runbook name. + +### [Update-AzAutomationAccount](Update-AzAutomationAccount.md) +Update an automation account. + +### [Update-AzAutomationCertificate](Update-AzAutomationCertificate.md) +Update a certificate. + +### [Update-AzAutomationConnection](Update-AzAutomationConnection.md) +Update a connection. + +### [Update-AzAutomationCredential](Update-AzAutomationCredential.md) +Update a credential. + +### [Update-AzAutomationDscNode](Update-AzAutomationDscNode.md) +Update the dsc node. + +### [Update-AzAutomationHybridRunbookWorkerGroup](Update-AzAutomationHybridRunbookWorkerGroup.md) +Update a hybrid runbook worker group. + +### [Update-AzAutomationModule](Update-AzAutomationModule.md) +Update the module identified by module name. + +### [Update-AzAutomationPython2Package](Update-AzAutomationPython2Package.md) +Update the python 2 package identified by package name. + +### [Update-AzAutomationRunbook](Update-AzAutomationRunbook.md) +Update the runbook identified by runbook name. + +### [Update-AzAutomationSchedule](Update-AzAutomationSchedule.md) +Update the schedule identified by schedule name. + +### [Update-AzAutomationSourceControl](Update-AzAutomationSourceControl.md) +Update a source control. + +### [Update-AzAutomationVariable](Update-AzAutomationVariable.md) +Update a variable. + +### [Update-AzAutomationWatcher](Update-AzAutomationWatcher.md) +Update the watcher identified by watcher name. + +### [Update-AzAutomationWebhook](Update-AzAutomationWebhook.md) +Update the webhook identified by webhook name. + diff --git a/swaggerci/automation/docs/Convert-AzAutomationGraphRunbookContent.md b/swaggerci/automation/docs/Convert-AzAutomationGraphRunbookContent.md new file mode 100644 index 000000000000..7ebec0e00e4d --- /dev/null +++ b/swaggerci/automation/docs/Convert-AzAutomationGraphRunbookContent.md @@ -0,0 +1,323 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/convert-azautomationgraphrunbookcontent +schema: 2.0.0 +--- + +# Convert-AzAutomationGraphRunbookContent + +## SYNOPSIS +Post operation to serialize or deserialize GraphRunbookContent + +## SYNTAX + +### ConvertExpanded (Default) +``` +Convert-AzAutomationGraphRunbookContent -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-GraphRunbookJson ] [-RawContentRunbookDefinition ] + [-RawContentRunbookType ] [-RawContentSchemaVersion ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### Convert +``` +Convert-AzAutomationGraphRunbookContent -AutomationAccountName -ResourceGroupName + -Parameter [-SubscriptionId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### ConvertViaIdentity +``` +Convert-AzAutomationGraphRunbookContent -InputObject + -Parameter [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### ConvertViaIdentityExpanded +``` +Convert-AzAutomationGraphRunbookContent -InputObject [-GraphRunbookJson ] + [-RawContentRunbookDefinition ] [-RawContentRunbookType ] + [-RawContentSchemaVersion ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Post operation to serialize or deserialize GraphRunbookContent + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Convert, ConvertExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -GraphRunbookJson +Graphical Runbook content as JSON + +```yaml +Type: System.String +Parameter Sets: ConvertExpanded, ConvertViaIdentityExpanded +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: ConvertViaIdentity, ConvertViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Parameter +Graphical Runbook Content +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IGraphicalRunbookContent +Parameter Sets: Convert, ConvertViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -RawContentRunbookDefinition +Serialized Graphical runbook + +```yaml +Type: System.String +Parameter Sets: ConvertExpanded, ConvertViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RawContentRunbookType +Runbook Type + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.GraphRunbookType +Parameter Sets: ConvertExpanded, ConvertViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RawContentSchemaVersion +Schema version of the serializer. + +```yaml +Type: System.String +Parameter Sets: ConvertExpanded, ConvertViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Convert, ConvertExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Convert, ConvertExpanded +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.Automation.Models.Api20210622.IGraphicalRunbookContent + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IGraphicalRunbookContent + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +PARAMETER : Graphical Runbook Content + - `[GraphRunbookJson ]`: Graphical Runbook content as JSON + - `[RawContentRunbookDefinition ]`: Serialized Graphical runbook + - `[RawContentRunbookType ]`: Runbook Type + - `[RawContentSchemaVersion ]`: Schema version of the serializer. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationAccount.md b/swaggerci/automation/docs/Get-AzAutomationAccount.md new file mode 100644 index 000000000000..cf8852105a8d --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationAccount.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationaccount +schema: 2.0.0 +--- + +# Get-AzAutomationAccount + +## SYNOPSIS +Get information about an Automation Account. + +## SYNTAX + +### List1 (Default) +``` +Get-AzAutomationAccount [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationAccount -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationAccount -InputObject [-DefaultProfile ] [] +``` + +### List +``` +Get-AzAutomationAccount -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Get information about an Automation Account. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +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 automation account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AutomationAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IAutomationAccount + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationActivity.md b/swaggerci/automation/docs/Get-AzAutomationActivity.md new file mode 100644 index 000000000000..3f44388352a9 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationActivity.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationactivity +schema: 2.0.0 +--- + +# Get-AzAutomationActivity + +## SYNOPSIS +Retrieve the activity in the module identified by module name and activity name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationActivity -AutomationAccountName -ModuleName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationActivity -AutomationAccountName -ModuleName -Name + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationActivity -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the activity in the module identified by module name and activity name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ModuleName +The name of module. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of activity. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ActivityName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IActivity + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationAgentRegistrationInformation.md b/swaggerci/automation/docs/Get-AzAutomationAgentRegistrationInformation.md new file mode 100644 index 000000000000..67240cb5b04d --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationAgentRegistrationInformation.md @@ -0,0 +1,192 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationagentregistrationinformation +schema: 2.0.0 +--- + +# Get-AzAutomationAgentRegistrationInformation + +## SYNOPSIS +Retrieve the automation agent registration information. + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomationAgentRegistrationInformation -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationAgentRegistrationInformation -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the automation agent registration information. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String[] +Parameter Sets: 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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IAgentRegistration + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationCertificate.md b/swaggerci/automation/docs/Get-AzAutomationCertificate.md new file mode 100644 index 000000000000..c8a1f4ef79e0 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationCertificate.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationcertificate +schema: 2.0.0 +--- + +# Get-AzAutomationCertificate + +## SYNOPSIS +Retrieve the certificate identified by certificate name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationCertificate -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationCertificate -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationCertificate -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the certificate identified by certificate name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of certificate. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ICertificate + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationConnection.md b/swaggerci/automation/docs/Get-AzAutomationConnection.md new file mode 100644 index 000000000000..2e9343b70900 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationConnection.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationconnection +schema: 2.0.0 +--- + +# Get-AzAutomationConnection + +## SYNOPSIS +Retrieve the connection identified by connection name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationConnection -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationConnection -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationConnection -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the connection identified by connection name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of connection. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IConnection + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationConnectionType.md b/swaggerci/automation/docs/Get-AzAutomationConnectionType.md new file mode 100644 index 000000000000..e820dda77db7 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationConnectionType.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationconnectiontype +schema: 2.0.0 +--- + +# Get-AzAutomationConnectionType + +## SYNOPSIS +Retrieve the connection type identified by connection type name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationConnectionType -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationConnectionType -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationConnectionType -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the connection type identified by connection type name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of connection type. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ConnectionTypeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IConnectionType + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationCredential.md b/swaggerci/automation/docs/Get-AzAutomationCredential.md new file mode 100644 index 000000000000..e1da82f5eca8 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationCredential.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationcredential +schema: 2.0.0 +--- + +# Get-AzAutomationCredential + +## SYNOPSIS +Retrieve the credential identified by credential name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationCredential -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationCredential -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationCredential -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the credential identified by credential name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of credential. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: CredentialName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ICredential + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationDscCompilationJob.md b/swaggerci/automation/docs/Get-AzAutomationDscCompilationJob.md new file mode 100644 index 000000000000..632e4e104700 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationDscCompilationJob.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationdsccompilationjob +schema: 2.0.0 +--- + +# Get-AzAutomationDscCompilationJob + +## SYNOPSIS +Retrieve the Dsc configuration compilation job identified by job id. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationDscCompilationJob -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationDscCompilationJob -AutomationAccountName -CompilationJobName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationDscCompilationJob -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the Dsc configuration compilation job identified by job id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompilationJobName +The DSC configuration Id. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IDscCompilationJob + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationDscCompilationJobStream.md b/swaggerci/automation/docs/Get-AzAutomationDscCompilationJobStream.md new file mode 100644 index 000000000000..6473454878fc --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationDscCompilationJobStream.md @@ -0,0 +1,230 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationdsccompilationjobstream +schema: 2.0.0 +--- + +# Get-AzAutomationDscCompilationJobStream + +## SYNOPSIS +Retrieve the job stream identified by job stream id. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationDscCompilationJobStream -AutomationAccountName -JobId + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationDscCompilationJobStream -AutomationAccountName -JobId -JobStreamId + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationDscCompilationJobStream -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the job stream identified by job stream id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobId +The job id. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobStreamId +The job stream id. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180630.IJobStream + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180630.IJobStreamListResult + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationDscConfiguration.md b/swaggerci/automation/docs/Get-AzAutomationDscConfiguration.md new file mode 100644 index 000000000000..94a54c381c36 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationDscConfiguration.md @@ -0,0 +1,274 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationdscconfiguration +schema: 2.0.0 +--- + +# Get-AzAutomationDscConfiguration + +## SYNOPSIS +Retrieve the configuration identified by configuration name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationDscConfiguration -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-Inlinecount ] [-Skip ] [-Top ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationDscConfiguration -AutomationAccountName -ConfigurationName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationDscConfiguration -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the configuration identified by configuration name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationName +The configuration name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Inlinecount +Return total rows. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +The number of rows to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Top +The number of rows to take. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.IDscConfiguration + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationDscConfigurationContent.md b/swaggerci/automation/docs/Get-AzAutomationDscConfigurationContent.md new file mode 100644 index 000000000000..690a9306a20b --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationDscConfigurationContent.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationdscconfigurationcontent +schema: 2.0.0 +--- + +# Get-AzAutomationDscConfigurationContent + +## SYNOPSIS +Retrieve the configuration script identified by configuration name. + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomationDscConfigurationContent -AutomationAccountName -ConfigurationName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + [] +``` + +### GetViaIdentity +``` +Get-AzAutomationDscConfigurationContent -InputObject [-DefaultProfile ] + [-PassThru] [] +``` + +## DESCRIPTION +Retrieve the configuration script identified by configuration name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationName +The configuration name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String[] +Parameter Sets: 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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationDscNode.md b/swaggerci/automation/docs/Get-AzAutomationDscNode.md new file mode 100644 index 000000000000..4877d4e94237 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationDscNode.md @@ -0,0 +1,273 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationdscnode +schema: 2.0.0 +--- + +# Get-AzAutomationDscNode + +## SYNOPSIS +Retrieve the dsc node identified by node id. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationDscNode -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-Inlinecount ] [-Skip ] [-Top ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationDscNode -AutomationAccountName -NodeId -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationDscNode -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the dsc node identified by node id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Inlinecount +Return total rows. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NodeId +The node id. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +The number of rows to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Top +The number of rows to take. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IDscNode + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationDscNodeConfiguration.md b/swaggerci/automation/docs/Get-AzAutomationDscNodeConfiguration.md new file mode 100644 index 000000000000..331de5473134 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationDscNodeConfiguration.md @@ -0,0 +1,274 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationdscnodeconfiguration +schema: 2.0.0 +--- + +# Get-AzAutomationDscNodeConfiguration + +## SYNOPSIS +Retrieve the Dsc node configurations by node configuration. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationDscNodeConfiguration -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-Inlinecount ] [-Skip ] [-Top ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationDscNodeConfiguration -AutomationAccountName -NodeConfigurationName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationDscNodeConfiguration -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the Dsc node configurations by node configuration. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Inlinecount +Return total rows. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NodeConfigurationName +The Dsc node configuration name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +The number of rows to skip. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Top +The number of rows to take. + +```yaml +Type: System.Int32 +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IDscNodeConfiguration + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationField.md b/swaggerci/automation/docs/Get-AzAutomationField.md new file mode 100644 index 000000000000..212ac60b2646 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationField.md @@ -0,0 +1,154 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationfield +schema: 2.0.0 +--- + +# Get-AzAutomationField + +## SYNOPSIS +Retrieve a list of fields of a given type identified by module name. + +## SYNTAX + +``` +Get-AzAutomationField -AutomationAccountName -ModuleName -ResourceGroupName + -TypeName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve a list of fields of a given type identified by module name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -ModuleName +The name of module. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -TypeName +The name of type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ITypeField + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationHybridRunbookWorker.md b/swaggerci/automation/docs/Get-AzAutomationHybridRunbookWorker.md new file mode 100644 index 000000000000..07ed8acc85bb --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationHybridRunbookWorker.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationhybridrunbookworker +schema: 2.0.0 +--- + +# Get-AzAutomationHybridRunbookWorker + +## SYNOPSIS +Retrieve a hybrid runbook worker. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationHybridRunbookWorker -AutomationAccountName -GroupName + -ResourceGroupName [-SubscriptionId ] [-Filter ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzAutomationHybridRunbookWorker -AutomationAccountName -GroupName -Id + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationHybridRunbookWorker -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve a hybrid runbook worker. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupName +The hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: HybridRunbookWorkerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The hybrid runbook worker id + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: HybridRunbookWorkerId + +Required: True +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IHybridRunbookWorker + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationHybridRunbookWorkerGroup.md b/swaggerci/automation/docs/Get-AzAutomationHybridRunbookWorkerGroup.md new file mode 100644 index 000000000000..de5e9c8a7950 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationHybridRunbookWorkerGroup.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationhybridrunbookworkergroup +schema: 2.0.0 +--- + +# Get-AzAutomationHybridRunbookWorkerGroup + +## SYNOPSIS +Retrieve a hybrid runbook worker group. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationHybridRunbookWorkerGroup -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationHybridRunbookWorkerGroup -AutomationAccountName -Name + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationHybridRunbookWorkerGroup -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve a hybrid runbook worker group. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: HybridRunbookWorkerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IHybridRunbookWorkerGroup + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationJob.md b/swaggerci/automation/docs/Get-AzAutomationJob.md new file mode 100644 index 000000000000..6cbec173415c --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationJob.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationjob +schema: 2.0.0 +--- + +# Get-AzAutomationJob + +## SYNOPSIS +Retrieve the job identified by job name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationJob -AutomationAccountName -ResourceGroupName [-SubscriptionId ] + [-Filter ] [-ClientRequestId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationJob -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-ClientRequestId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationJob -InputObject [-ClientRequestId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the job identified by job name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The job name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.IJob + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.IJobCollectionItem + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationJobOutput.md b/swaggerci/automation/docs/Get-AzAutomationJobOutput.md new file mode 100644 index 000000000000..8b1ef1582dec --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationJobOutput.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationjoboutput +schema: 2.0.0 +--- + +# Get-AzAutomationJobOutput + +## SYNOPSIS +Retrieve the job output identified by job name. + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomationJobOutput -AutomationAccountName -JobName -ResourceGroupName + [-SubscriptionId ] [-ClientRequestId ] [-DefaultProfile ] [-PassThru] + [] +``` + +### GetViaIdentity +``` +Get-AzAutomationJobOutput -InputObject [-ClientRequestId ] + [-DefaultProfile ] [-PassThru] [] +``` + +## DESCRIPTION +Retrieve the job output identified by job name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The name of the job to be created. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String[] +Parameter Sets: 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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationJobRunbookContent.md b/swaggerci/automation/docs/Get-AzAutomationJobRunbookContent.md new file mode 100644 index 000000000000..ba572187cdc3 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationJobRunbookContent.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationjobrunbookcontent +schema: 2.0.0 +--- + +# Get-AzAutomationJobRunbookContent + +## SYNOPSIS +Retrieve the runbook content of the job identified by job name. + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomationJobRunbookContent -AutomationAccountName -JobName + -ResourceGroupName [-SubscriptionId ] [-ClientRequestId ] + [-DefaultProfile ] [-PassThru] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationJobRunbookContent -InputObject [-ClientRequestId ] + [-DefaultProfile ] [-PassThru] [] +``` + +## DESCRIPTION +Retrieve the runbook content of the job identified by job name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The job name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String[] +Parameter Sets: 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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationJobSchedule.md b/swaggerci/automation/docs/Get-AzAutomationJobSchedule.md new file mode 100644 index 000000000000..d0bd75c2694e --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationJobSchedule.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationjobschedule +schema: 2.0.0 +--- + +# Get-AzAutomationJobSchedule + +## SYNOPSIS +Retrieve the job schedule identified by job schedule name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationJobSchedule -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationJobSchedule -AutomationAccountName -Id -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationJobSchedule -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the job schedule identified by job schedule name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The job schedule name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: JobScheduleId + +Required: True +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IJobSchedule + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationJobStream.md b/swaggerci/automation/docs/Get-AzAutomationJobStream.md new file mode 100644 index 000000000000..75f22dc3e759 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationJobStream.md @@ -0,0 +1,260 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationjobstream +schema: 2.0.0 +--- + +# Get-AzAutomationJobStream + +## SYNOPSIS +Retrieve the job stream identified by job stream id. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationJobStream -AutomationAccountName -JobName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-ClientRequestId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzAutomationJobStream -AutomationAccountName -Id -JobName + -ResourceGroupName [-SubscriptionId ] [-ClientRequestId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationJobStream -InputObject [-ClientRequestId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the job stream identified by job stream id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The job stream id. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: JobStreamId + +Required: True +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobName +The job name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180630.IJobStream + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationKey.md b/swaggerci/automation/docs/Get-AzAutomationKey.md new file mode 100644 index 000000000000..85791f80e788 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationKey.md @@ -0,0 +1,155 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationkey +schema: 2.0.0 +--- + +# Get-AzAutomationKey + +## SYNOPSIS +Retrieve the automation keys for an account. + +## SYNTAX + +``` +Get-AzAutomationKey -AutomationAccountName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Retrieve the automation keys for an account. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IKey + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationLinkedWorkspace.md b/swaggerci/automation/docs/Get-AzAutomationLinkedWorkspace.md new file mode 100644 index 000000000000..3861d096f36a --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationLinkedWorkspace.md @@ -0,0 +1,192 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationlinkedworkspace +schema: 2.0.0 +--- + +# Get-AzAutomationLinkedWorkspace + +## SYNOPSIS +Retrieve the linked workspace for the account id. + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomationLinkedWorkspace -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationLinkedWorkspace -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the linked workspace for the account id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String[] +Parameter Sets: 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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationModule.md b/swaggerci/automation/docs/Get-AzAutomationModule.md new file mode 100644 index 000000000000..23bfd1fb8dbb --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationModule.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationmodule +schema: 2.0.0 +--- + +# Get-AzAutomationModule + +## SYNOPSIS +Retrieve the module identified by module name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationModule -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationModule -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationModule -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the module identified by module name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The module name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ModuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IModule + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationNodeCountInformation.md b/swaggerci/automation/docs/Get-AzAutomationNodeCountInformation.md new file mode 100644 index 000000000000..0630a9a9affa --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationNodeCountInformation.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationnodecountinformation +schema: 2.0.0 +--- + +# Get-AzAutomationNodeCountInformation + +## SYNOPSIS +Retrieve counts for Dsc Nodes. + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomationNodeCountInformation -AutomationAccountName -CountType + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationNodeCountInformation -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve counts for Dsc Nodes. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountType +The type of counts to retrieve + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.CountType +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String[] +Parameter Sets: 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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.INodeCounts + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationNodeReport.md b/swaggerci/automation/docs/Get-AzAutomationNodeReport.md new file mode 100644 index 000000000000..7685fffeaddf --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationNodeReport.md @@ -0,0 +1,243 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationnodereport +schema: 2.0.0 +--- + +# Get-AzAutomationNodeReport + +## SYNOPSIS +Retrieve the Dsc node report data by node id and report id. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationNodeReport -AutomationAccountName -NodeId -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationNodeReport -AutomationAccountName -NodeId -ReportId + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationNodeReport -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the Dsc node report data by node id and report id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NodeId +The Dsc node id. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportId +The report id. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IDscNodeReport + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationNodeReportContent.md b/swaggerci/automation/docs/Get-AzAutomationNodeReportContent.md new file mode 100644 index 000000000000..1b365431ad88 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationNodeReportContent.md @@ -0,0 +1,222 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationnodereportcontent +schema: 2.0.0 +--- + +# Get-AzAutomationNodeReportContent + +## SYNOPSIS +Retrieve the Dsc node reports by node id and report id. + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomationNodeReportContent -AutomationAccountName -NodeId -ReportId + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationNodeReportContent -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the Dsc node reports by node id and report id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NodeId +The Dsc node id. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportId +The report id. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String[] +Parameter Sets: 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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.IAny + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationObjectDataTypeField.md b/swaggerci/automation/docs/Get-AzAutomationObjectDataTypeField.md new file mode 100644 index 000000000000..40a004ea04f3 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationObjectDataTypeField.md @@ -0,0 +1,162 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationobjectdatatypefield +schema: 2.0.0 +--- + +# Get-AzAutomationObjectDataTypeField + +## SYNOPSIS +Retrieve a list of fields of a given type identified by module name. + +## SYNTAX + +### List1 (Default) +``` +Get-AzAutomationObjectDataTypeField -AutomationAccountName -ResourceGroupName + -TypeName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### List +``` +Get-AzAutomationObjectDataTypeField -AutomationAccountName -ModuleName + -ResourceGroupName -TypeName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve a list of fields of a given type identified by module name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -ModuleName +The name of module. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -TypeName +The name of type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ITypeField + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationPrivateEndpointConnection.md b/swaggerci/automation/docs/Get-AzAutomationPrivateEndpointConnection.md new file mode 100644 index 000000000000..8bc50e24c809 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationPrivateEndpointConnection.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationprivateendpointconnection +schema: 2.0.0 +--- + +# Get-AzAutomationPrivateEndpointConnection + +## SYNOPSIS +Gets a private endpoint connection. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationPrivateEndpointConnection -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationPrivateEndpointConnection -AutomationAccountName -Name + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationPrivateEndpointConnection -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets a private endpoint connection. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +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 +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180610.IPrivateEndpointConnection + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationPython2Package.md b/swaggerci/automation/docs/Get-AzAutomationPython2Package.md new file mode 100644 index 000000000000..83e7e0cb99cd --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationPython2Package.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationpython2package +schema: 2.0.0 +--- + +# Get-AzAutomationPython2Package + +## SYNOPSIS +Retrieve the python 2 package identified by package name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationPython2Package -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationPython2Package -AutomationAccountName -PackageName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationPython2Package -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the python 2 package identified by package name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PackageName +The python package name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IModule + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationRunbook.md b/swaggerci/automation/docs/Get-AzAutomationRunbook.md new file mode 100644 index 000000000000..53b094eae493 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationRunbook.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationrunbook +schema: 2.0.0 +--- + +# Get-AzAutomationRunbook + +## SYNOPSIS +Retrieve the runbook identified by runbook name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationRunbook -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationRunbook -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationRunbook -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the runbook identified by runbook name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The runbook name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: RunbookName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180630.IRunbook + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationRunbookContent.md b/swaggerci/automation/docs/Get-AzAutomationRunbookContent.md new file mode 100644 index 000000000000..6062d1b3e86a --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationRunbookContent.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationrunbookcontent +schema: 2.0.0 +--- + +# Get-AzAutomationRunbookContent + +## SYNOPSIS +Retrieve the content of runbook identified by runbook name. + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomationRunbookContent -AutomationAccountName -ResourceGroupName + -RunbookName -OutFile [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + [] +``` + +### GetViaIdentity +``` +Get-AzAutomationRunbookContent -InputObject -OutFile + [-DefaultProfile ] [-PassThru] [] +``` + +## DESCRIPTION +Retrieve the content of runbook identified by runbook name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OutFile +Path to write output file to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +The runbook name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String[] +Parameter Sets: 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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationRunbookDraft.md b/swaggerci/automation/docs/Get-AzAutomationRunbookDraft.md new file mode 100644 index 000000000000..535e221ca503 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationRunbookDraft.md @@ -0,0 +1,207 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationrunbookdraft +schema: 2.0.0 +--- + +# Get-AzAutomationRunbookDraft + +## SYNOPSIS +Retrieve the runbook draft identified by runbook name. + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomationRunbookDraft -AutomationAccountName -ResourceGroupName -RunbookName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationRunbookDraft -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the runbook draft identified by runbook name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +The runbook name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String[] +Parameter Sets: 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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180630.IRunbookDraft + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationRunbookDraftContent.md b/swaggerci/automation/docs/Get-AzAutomationRunbookDraftContent.md new file mode 100644 index 000000000000..7d3b6417845d --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationRunbookDraftContent.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationrunbookdraftcontent +schema: 2.0.0 +--- + +# Get-AzAutomationRunbookDraftContent + +## SYNOPSIS +Retrieve the content of runbook draft identified by runbook name. + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomationRunbookDraftContent -AutomationAccountName -ResourceGroupName + -RunbookName -OutFile [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + [] +``` + +### GetViaIdentity +``` +Get-AzAutomationRunbookDraftContent -InputObject -OutFile + [-DefaultProfile ] [-PassThru] [] +``` + +## DESCRIPTION +Retrieve the content of runbook draft identified by runbook name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -OutFile +Path to write output file to + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +The runbook name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String[] +Parameter Sets: 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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationSchedule.md b/swaggerci/automation/docs/Get-AzAutomationSchedule.md new file mode 100644 index 000000000000..e0e43c654a69 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationSchedule.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationschedule +schema: 2.0.0 +--- + +# Get-AzAutomationSchedule + +## SYNOPSIS +Retrieve the schedule identified by schedule name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationSchedule -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationSchedule -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationSchedule -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the schedule identified by schedule name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The schedule name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ScheduleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ISchedule + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationSoftwareUpdateConfiguration.md b/swaggerci/automation/docs/Get-AzAutomationSoftwareUpdateConfiguration.md new file mode 100644 index 000000000000..3766edd4e2d7 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationSoftwareUpdateConfiguration.md @@ -0,0 +1,247 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationsoftwareupdateconfiguration +schema: 2.0.0 +--- + +# Get-AzAutomationSoftwareUpdateConfiguration + +## SYNOPSIS +Get a single software update configuration by name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationSoftwareUpdateConfiguration -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-ClientRequestId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzAutomationSoftwareUpdateConfiguration -AutomationAccountName -Name + -ResourceGroupName [-SubscriptionId ] [-ClientRequestId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationSoftwareUpdateConfiguration -InputObject [-ClientRequestId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a single software update configuration by name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +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 software update configuration to be created. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SoftwareUpdateConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.ISoftwareUpdateConfiguration + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.ISoftwareUpdateConfigurationCollectionItem + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationSoftwareUpdateConfigurationMachineRun.md b/swaggerci/automation/docs/Get-AzAutomationSoftwareUpdateConfigurationMachineRun.md new file mode 100644 index 000000000000..ac71580467b2 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationSoftwareUpdateConfigurationMachineRun.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationsoftwareupdateconfigurationmachinerun +schema: 2.0.0 +--- + +# Get-AzAutomationSoftwareUpdateConfigurationMachineRun + +## SYNOPSIS +Get a single software update configuration machine run by Id. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationSoftwareUpdateConfigurationMachineRun -AutomationAccountName + -ResourceGroupName [-SubscriptionId ] [-Filter ] [-Skip ] [-Top ] + [-ClientRequestId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationSoftwareUpdateConfigurationMachineRun -AutomationAccountName -Id + -ResourceGroupName [-SubscriptionId ] [-ClientRequestId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationSoftwareUpdateConfigurationMachineRun -InputObject + [-ClientRequestId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a single software update configuration machine run by Id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. +You can use the following filters: 'properties/osType', 'properties/status', 'properties/startTime', and 'properties/softwareUpdateConfiguration/name' + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The Id of the software update configuration machine run. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SoftwareUpdateConfigurationMachineRunId + +Required: True +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +number of entries you skip before returning results + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Top +Maximum number of entries returned in the results collection + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.ISoftwareUpdateConfigurationMachineRun + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.ISoftwareUpdateConfigurationMachineRunListResult + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationSoftwareUpdateConfigurationRun.md b/swaggerci/automation/docs/Get-AzAutomationSoftwareUpdateConfigurationRun.md new file mode 100644 index 000000000000..c201765a9691 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationSoftwareUpdateConfigurationRun.md @@ -0,0 +1,278 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationsoftwareupdateconfigurationrun +schema: 2.0.0 +--- + +# Get-AzAutomationSoftwareUpdateConfigurationRun + +## SYNOPSIS +Get a single software update configuration Run by Id. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationSoftwareUpdateConfigurationRun -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-Skip ] [-Top ] [-ClientRequestId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationSoftwareUpdateConfigurationRun -AutomationAccountName -Id + -ResourceGroupName [-SubscriptionId ] [-ClientRequestId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationSoftwareUpdateConfigurationRun -InputObject [-ClientRequestId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a single software update configuration Run by Id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. +You can use the following filters: 'properties/osType', 'properties/status', 'properties/startTime', and 'properties/softwareUpdateConfiguration/name' + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The Id of the software update configuration run. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SoftwareUpdateConfigurationRunId + +Required: True +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Skip +Number of entries you skip before returning results + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Top +Maximum number of entries returned in the results collection + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.ISoftwareUpdateConfigurationRun + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.ISoftwareUpdateConfigurationRunListResult + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationSourceControl.md b/swaggerci/automation/docs/Get-AzAutomationSourceControl.md new file mode 100644 index 000000000000..f438152d727a --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationSourceControl.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationsourcecontrol +schema: 2.0.0 +--- + +# Get-AzAutomationSourceControl + +## SYNOPSIS +Retrieve the source control identified by source control name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationSourceControl -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationSourceControl -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationSourceControl -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the source control identified by source control name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of source control. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SourceControlName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ISourceControl + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationSourceControlSyncJob.md b/swaggerci/automation/docs/Get-AzAutomationSourceControlSyncJob.md new file mode 100644 index 000000000000..52dcf2e2af62 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationSourceControlSyncJob.md @@ -0,0 +1,246 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationsourcecontrolsyncjob +schema: 2.0.0 +--- + +# Get-AzAutomationSourceControlSyncJob + +## SYNOPSIS +Retrieve the source control sync job identified by job id. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationSourceControlSyncJob -AutomationAccountName -ResourceGroupName + -SourceControlName [-SubscriptionId ] [-Filter ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzAutomationSourceControlSyncJob -AutomationAccountName -Id -ResourceGroupName + -SourceControlName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationSourceControlSyncJob -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve the source control sync job identified by job id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The source control sync job id. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: SourceControlSyncJobId + +Required: True +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceControlName +The source control name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ISourceControlSyncJob + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ISourceControlSyncJobById + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationSourceControlSyncJobStream.md b/swaggerci/automation/docs/Get-AzAutomationSourceControlSyncJobStream.md new file mode 100644 index 000000000000..72ee6621cfb8 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationSourceControlSyncJobStream.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationsourcecontrolsyncjobstream +schema: 2.0.0 +--- + +# Get-AzAutomationSourceControlSyncJobStream + +## SYNOPSIS +Retrieve a sync job stream identified by stream id. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationSourceControlSyncJobStream -AutomationAccountName -ResourceGroupName + -SourceControlName -SourceControlSyncJobId [-SubscriptionId ] [-Filter ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationSourceControlSyncJobStream -AutomationAccountName -ResourceGroupName + -SourceControlName -SourceControlSyncJobId -StreamId [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationSourceControlSyncJobStream -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve a sync job stream identified by stream id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceControlName +The source control name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceControlSyncJobId +The source control sync job id. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StreamId +The id of the sync job stream. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ISourceControlSyncJobStream + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ISourceControlSyncJobStreamById + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationStatistics.md b/swaggerci/automation/docs/Get-AzAutomationStatistics.md new file mode 100644 index 000000000000..b5e5505c52af --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationStatistics.md @@ -0,0 +1,139 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationstatistics +schema: 2.0.0 +--- + +# Get-AzAutomationStatistics + +## SYNOPSIS +Retrieve the statistics for the account. + +## SYNTAX + +``` +Get-AzAutomationStatistics -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the statistics for the account. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IStatistics + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationTestJob.md b/swaggerci/automation/docs/Get-AzAutomationTestJob.md new file mode 100644 index 000000000000..da84d6190e97 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationTestJob.md @@ -0,0 +1,206 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationtestjob +schema: 2.0.0 +--- + +# Get-AzAutomationTestJob + +## SYNOPSIS +Retrieve the test job for the specified runbook. + +## SYNTAX + +### Get (Default) +``` +Get-AzAutomationTestJob -AutomationAccountName -ResourceGroupName -RunbookName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationTestJob -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the test job for the specified runbook. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +The runbook name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String[] +Parameter Sets: 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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180630.ITestJob + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationTestJobStream.md b/swaggerci/automation/docs/Get-AzAutomationTestJobStream.md new file mode 100644 index 000000000000..e7af5bd25e8f --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationTestJobStream.md @@ -0,0 +1,245 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationtestjobstream +schema: 2.0.0 +--- + +# Get-AzAutomationTestJobStream + +## SYNOPSIS +Retrieve a test job stream of the test job identified by runbook name and stream id. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationTestJobStream -AutomationAccountName -ResourceGroupName + -RunbookName [-SubscriptionId ] [-Filter ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzAutomationTestJobStream -AutomationAccountName -JobStreamId + -ResourceGroupName -RunbookName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzAutomationTestJobStream -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Retrieve a test job stream of the test job identified by runbook name and stream id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobStreamId +The job stream id. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +The runbook name. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180630.IJobStream + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationUsage.md b/swaggerci/automation/docs/Get-AzAutomationUsage.md new file mode 100644 index 000000000000..5777482d22fb --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationUsage.md @@ -0,0 +1,124 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationusage +schema: 2.0.0 +--- + +# Get-AzAutomationUsage + +## SYNOPSIS +Retrieve the usage for the account id. + +## SYNTAX + +``` +Get-AzAutomationUsage -AutomationAccountName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the usage for the account id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IUsage + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationVariable.md b/swaggerci/automation/docs/Get-AzAutomationVariable.md new file mode 100644 index 000000000000..0afddf635ad0 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationVariable.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationvariable +schema: 2.0.0 +--- + +# Get-AzAutomationVariable + +## SYNOPSIS +Retrieve the variable identified by variable name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationVariable -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationVariable -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationVariable -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the variable identified by variable name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of variable. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: VariableName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IVariable + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationWatcher.md b/swaggerci/automation/docs/Get-AzAutomationWatcher.md new file mode 100644 index 000000000000..ea8c69d3c304 --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationWatcher.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationwatcher +schema: 2.0.0 +--- + +# Get-AzAutomationWatcher + +## SYNOPSIS +Retrieve the watcher identified by watcher name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationWatcher -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationWatcher -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationWatcher -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the watcher identified by watcher name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The watcher name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: WatcherName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IWatcher + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Get-AzAutomationWebhook.md b/swaggerci/automation/docs/Get-AzAutomationWebhook.md new file mode 100644 index 000000000000..736c45132fae --- /dev/null +++ b/swaggerci/automation/docs/Get-AzAutomationWebhook.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/get-azautomationwebhook +schema: 2.0.0 +--- + +# Get-AzAutomationWebhook + +## SYNOPSIS +Retrieve the webhook identified by webhook name. + +## SYNTAX + +### List (Default) +``` +Get-AzAutomationWebhook -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-Filter ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzAutomationWebhook -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzAutomationWebhook -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Retrieve the webhook identified by webhook name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Filter +The filter to apply on the operation. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The webhook name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: WebhookName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```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 +Gets subscription credentials which uniquely identify Microsoft Azure subscription. +The subscription ID forms part of the URI for every service call. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20151031.IWebhook + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Invoke-AzAutomationPrivateLinkResource.md b/swaggerci/automation/docs/Invoke-AzAutomationPrivateLinkResource.md new file mode 100644 index 000000000000..bb4428642d21 --- /dev/null +++ b/swaggerci/automation/docs/Invoke-AzAutomationPrivateLinkResource.md @@ -0,0 +1,192 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/invoke-azautomationprivatelinkresource +schema: 2.0.0 +--- + +# Invoke-AzAutomationPrivateLinkResource + +## SYNOPSIS +Gets the private link resources that need to be created for Automation account. + +## SYNTAX + +### Automation (Default) +``` +Invoke-AzAutomationPrivateLinkResource -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### AutomationViaIdentity +``` +Invoke-AzAutomationPrivateLinkResource -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets the private link resources that need to be created for Automation account. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Automation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: AutomationViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Automation +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Automation +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IPrivateLinkResource + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Move-AzAutomationHybridRunbookWorker.md b/swaggerci/automation/docs/Move-AzAutomationHybridRunbookWorker.md new file mode 100644 index 000000000000..de544354087a --- /dev/null +++ b/swaggerci/automation/docs/Move-AzAutomationHybridRunbookWorker.md @@ -0,0 +1,335 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/move-azautomationhybridrunbookworker +schema: 2.0.0 +--- + +# Move-AzAutomationHybridRunbookWorker + +## SYNOPSIS +Move a hybrid worker to a different group. + +## SYNTAX + +### MoveExpanded (Default) +``` +Move-AzAutomationHybridRunbookWorker -AutomationAccountName -GroupName -Id + -ResourceGroupName [-SubscriptionId ] [-HybridRunbookWorkerGroupName1 ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### Move +``` +Move-AzAutomationHybridRunbookWorker -AutomationAccountName -GroupName -Id + -ResourceGroupName -HybridRunbookWorkerMoveParameter + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### MoveViaIdentity +``` +Move-AzAutomationHybridRunbookWorker -InputObject + -HybridRunbookWorkerMoveParameter [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### MoveViaIdentityExpanded +``` +Move-AzAutomationHybridRunbookWorker -InputObject + [-HybridRunbookWorkerGroupName ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Move a hybrid worker to a different group. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Move, MoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -GroupName +The hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: Move, MoveExpanded +Aliases: HybridRunbookWorkerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridRunbookWorkerGroupName +Gets or sets the target hybrid runbook worker group. + +```yaml +Type: System.String +Parameter Sets: MoveViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridRunbookWorkerGroupName1 +Gets or sets the target hybrid runbook worker group. + +```yaml +Type: System.String +Parameter Sets: MoveExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HybridRunbookWorkerMoveParameter +Parameters supplied to move hybrid worker operation. +To construct, see NOTES section for HYBRIDRUNBOOKWORKERMOVEPARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IHybridRunbookWorkerMoveParameters +Parameter Sets: Move, MoveViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Id +The hybrid runbook worker id + +```yaml +Type: System.String +Parameter Sets: Move, MoveExpanded +Aliases: HybridRunbookWorkerId + +Required: True +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.Automation.Models.IAutomationIdentity +Parameter Sets: MoveViaIdentity, MoveViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Move, MoveExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Move, MoveExpanded +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.Automation.Models.Api20210622.IHybridRunbookWorkerMoveParameters + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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. + + +HYBRIDRUNBOOKWORKERMOVEPARAMETER : Parameters supplied to move hybrid worker operation. + - `[HybridRunbookWorkerGroupName ]`: Gets or sets the target hybrid runbook worker group. + +INPUTOBJECT : Identity Parameter + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationAccount.md b/swaggerci/automation/docs/New-AzAutomationAccount.md new file mode 100644 index 000000000000..4c32c5e94279 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationAccount.md @@ -0,0 +1,387 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationaccount +schema: 2.0.0 +--- + +# New-AzAutomationAccount + +## SYNOPSIS +Create or update automation account. + +## SYNTAX + +``` +New-AzAutomationAccount -AutomationAccountName -ResourceGroupName [-SubscriptionId ] + [-DisableLocalAuth] [-EncryptionKeySource ] [-IdentityType ] + [-IdentityUserAssignedIdentity ] [-KeyVaultPropertyKeyName ] + [-KeyVaultPropertyKeyvaultUri ] [-KeyVaultPropertyKeyVersion ] [-Location ] + [-Name ] [-PropertiesEncryptionIdentityUserAssignedIdentity ] [-PublicNetworkAccess] + [-SkuCapacity ] [-SkuFamily ] [-SkuName ] [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create or update automation account. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -DisableLocalAuth +Indicates whether requests using non-AAD authentication are blocked + +```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 +``` + +### -EncryptionKeySource +Encryption Key Source + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.EncryptionKeySourceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +The list of user identities associated with the resource. +The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyName +The name of key used to encrypt data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyvaultUri +The URI of the key vault key used to encrypt data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyVersion +The key version of the key used to encrypt data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Gets or sets the location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertiesEncryptionIdentityUserAssignedIdentity +The user identity used for CMK. +It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.IAny +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet + +```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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Gets or sets the SKU capacity. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +Gets or sets the SKU family. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Gets or sets the SKU name of the account. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.SkuNameEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Tag +Gets or sets the tags attached to the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IAutomationAccount + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationAgentRegistrationInformationKey.md b/swaggerci/automation/docs/New-AzAutomationAgentRegistrationInformationKey.md new file mode 100644 index 000000000000..4db0152aee3f --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationAgentRegistrationInformationKey.md @@ -0,0 +1,274 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationagentregistrationinformationkey +schema: 2.0.0 +--- + +# New-AzAutomationAgentRegistrationInformationKey + +## SYNOPSIS +Regenerate a primary or secondary agent registration key + +## SYNTAX + +### RegenerateExpanded (Default) +``` +New-AzAutomationAgentRegistrationInformationKey -AutomationAccountName -ResourceGroupName + -KeyName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### Regenerate +``` +New-AzAutomationAgentRegistrationInformationKey -AutomationAccountName -ResourceGroupName + -Parameter [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### RegenerateViaIdentity +``` +New-AzAutomationAgentRegistrationInformationKey -InputObject + -Parameter [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### RegenerateViaIdentityExpanded +``` +New-AzAutomationAgentRegistrationInformationKey -InputObject + -KeyName [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Regenerate a primary or secondary agent registration key + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Regenerate, RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: RegenerateViaIdentity, RegenerateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +Gets or sets the agent registration key name - primary or secondary. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.AgentRegistrationKeyName +Parameter Sets: RegenerateExpanded, RegenerateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +The parameters supplied to the regenerate keys operation. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IAgentRegistrationRegenerateKeyParameter +Parameter Sets: Regenerate, RegenerateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Regenerate, RegenerateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Regenerate, RegenerateExpanded +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.Automation.Models.Api20200113Preview.IAgentRegistrationRegenerateKeyParameter + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IAgentRegistration + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +PARAMETER : The parameters supplied to the regenerate keys operation. + - `KeyName `: Gets or sets the agent registration key name - primary or secondary. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationCertificate.md b/swaggerci/automation/docs/New-AzAutomationCertificate.md new file mode 100644 index 000000000000..076cc582344c --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationCertificate.md @@ -0,0 +1,247 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationcertificate +schema: 2.0.0 +--- + +# New-AzAutomationCertificate + +## SYNOPSIS +Create a certificate. + +## SYNTAX + +``` +New-AzAutomationCertificate -AutomationAccountName -CertificateName + -ResourceGroupName -Base64Value -Name [-SubscriptionId ] + [-Description ] [-IsExportable] [-Thumbprint ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create a certificate. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Base64Value +Gets or sets the base64 encoded value of the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateName +The parameters supplied to the create or update certificate operation. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsExportable +Gets or sets the is exportable flag of the certificate. + +```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 +``` + +### -Name +Gets or sets the name of the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Thumbprint +Gets or sets the thumbprint of the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ICertificate + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationConnection.md b/swaggerci/automation/docs/New-AzAutomationConnection.md new file mode 100644 index 000000000000..c7e1483c0c05 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationConnection.md @@ -0,0 +1,232 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationconnection +schema: 2.0.0 +--- + +# New-AzAutomationConnection + +## SYNOPSIS +Create or update a connection. + +## SYNTAX + +``` +New-AzAutomationConnection -AutomationAccountName -ConnectionName + -ResourceGroupName -Name [-SubscriptionId ] [-ConnectionTypeName ] + [-Description ] [-FieldDefinitionValue ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create or update a connection. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionName +The parameters supplied to the create or update connection operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionTypeName +Gets or sets the name of the connection type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FieldDefinitionValue +Gets or sets the field definition properties of the connection. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IConnection + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationConnectionType.md b/swaggerci/automation/docs/New-AzAutomationConnectionType.md new file mode 100644 index 000000000000..3de8feb4519d --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationConnectionType.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationconnectiontype +schema: 2.0.0 +--- + +# New-AzAutomationConnectionType + +## SYNOPSIS +Create a connection type. + +## SYNTAX + +``` +New-AzAutomationConnectionType -AutomationAccountName -ConnectionTypeName + -ResourceGroupName -FieldDefinition -Name [-SubscriptionId ] + [-IsGlobal] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a connection type. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionTypeName +The parameters supplied to the create or update connection type operation. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -FieldDefinition +Gets or sets the field definitions of the connection type. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsGlobal +Gets or sets a Boolean value to indicate if the connection type is global. + +```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 +``` + +### -Name +Gets or sets the name of the connection type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IConnectionType + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationCredential.md b/swaggerci/automation/docs/New-AzAutomationCredential.md new file mode 100644 index 000000000000..e9f75beb9930 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationCredential.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationcredential +schema: 2.0.0 +--- + +# New-AzAutomationCredential + +## SYNOPSIS +Create a credential. + +## SYNTAX + +``` +New-AzAutomationCredential -AutomationAccountName -CredentialName + -ResourceGroupName -Name -Password -UserName [-SubscriptionId ] + [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a credential. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialName +The parameters supplied to the create or update credential operation. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Gets or sets the password of the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -UserName +Gets or sets the user name of the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +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. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ICredential + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationDscCompilationJob.md b/swaggerci/automation/docs/New-AzAutomationDscCompilationJob.md new file mode 100644 index 000000000000..219ccd783c63 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationDscCompilationJob.md @@ -0,0 +1,292 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationdsccompilationjob +schema: 2.0.0 +--- + +# New-AzAutomationDscCompilationJob + +## SYNOPSIS +Creates the Dsc compilation job of the configuration. + +## SYNTAX + +``` +New-AzAutomationDscCompilationJob -AutomationAccountName -CompilationJobName + -ResourceGroupName [-SubscriptionId ] [-ConfigurationName ] + [-IncrementNodeConfigurationBuild] [-Location ] [-Name ] [-Parameter ] + [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates the Dsc compilation job of the configuration. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CompilationJobName +The DSC configuration Id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationName +Gets or sets the name of the Dsc configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -IncrementNodeConfigurationBuild +If a new build version of NodeConfiguration is required. + +```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 +``` + +### -Location +Gets or sets the location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +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 +Gets or sets the parameters of the job. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Tag +Gets or sets the tags attached to the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationDscNodeConfiguration.md b/swaggerci/automation/docs/New-AzAutomationDscNodeConfiguration.md new file mode 100644 index 000000000000..8826f159ad71 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationDscNodeConfiguration.md @@ -0,0 +1,354 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationdscnodeconfiguration +schema: 2.0.0 +--- + +# New-AzAutomationDscNodeConfiguration + +## SYNOPSIS +Create the node configuration identified by node configuration name. + +## SYNTAX + +``` +New-AzAutomationDscNodeConfiguration -AutomationAccountName -NodeConfigurationName + -ResourceGroupName [-SubscriptionId ] [-ConfigurationName ] + [-HashAlgorithm ] [-HashValue ] [-IncrementNodeConfigurationBuild] [-Name ] + [-SourceType ] [-SourceValue ] [-SourceVersion ] [-Tag ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create the node configuration identified by node configuration name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationName +Gets or sets the name of the Dsc configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -HashAlgorithm +Gets or sets the content hash algorithm used to hash the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HashValue +Gets or sets expected hash value of the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncrementNodeConfigurationBuild +If a new build version of NodeConfiguration is required. + +```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 +``` + +### -Name +Name of the node configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeConfigurationName +The Dsc node configuration name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceType +Gets or sets the content source type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.ContentSourceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceValue +Gets or sets the value of the content. +This is based on the content source type. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceVersion +Gets or sets the version of the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Tag +Gets or sets the tags attached to the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationHybridRunbookWorker.md b/swaggerci/automation/docs/New-AzAutomationHybridRunbookWorker.md new file mode 100644 index 000000000000..ff5563e7e10c --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationHybridRunbookWorker.md @@ -0,0 +1,216 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationhybridrunbookworker +schema: 2.0.0 +--- + +# New-AzAutomationHybridRunbookWorker + +## SYNOPSIS +Create a hybrid runbook worker. + +## SYNTAX + +``` +New-AzAutomationHybridRunbookWorker -AutomationAccountName -GroupName -Id + -ResourceGroupName [-SubscriptionId ] [-Name ] [-VMResourceId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a hybrid runbook worker. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -GroupName +The hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HybridRunbookWorkerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The hybrid runbook worker id + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HybridRunbookWorkerId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -VMResourceId +Azure Resource Manager Id for a virtual machine. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IHybridRunbookWorker + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationHybridRunbookWorkerGroup.md b/swaggerci/automation/docs/New-AzAutomationHybridRunbookWorkerGroup.md new file mode 100644 index 000000000000..34b59da46053 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationHybridRunbookWorkerGroup.md @@ -0,0 +1,186 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationhybridrunbookworkergroup +schema: 2.0.0 +--- + +# New-AzAutomationHybridRunbookWorkerGroup + +## SYNOPSIS +Create a hybrid runbook worker group. + +## SYNTAX + +``` +New-AzAutomationHybridRunbookWorkerGroup -AutomationAccountName -Name + -ResourceGroupName [-SubscriptionId ] [-CredentialName ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a hybrid runbook worker group. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialName +Gets or sets the name of the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: HybridRunbookWorkerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IHybridRunbookWorkerGroup + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationJob.md b/swaggerci/automation/docs/New-AzAutomationJob.md new file mode 100644 index 000000000000..43998830ca4b --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationJob.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationjob +schema: 2.0.0 +--- + +# New-AzAutomationJob + +## SYNOPSIS +Create a job of the runbook. + +## SYNTAX + +``` +New-AzAutomationJob -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-ClientRequestId ] [-Parameter ] [-RunbookName ] + [-RunOn ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a job of the runbook. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 job name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Gets or sets the parameters of the job. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +Gets or sets the name of the runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunOn +Gets or sets the runOn which specifies the group name where the job is to be executed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.IJob + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationJobSchedule.md b/swaggerci/automation/docs/New-AzAutomationJobSchedule.md new file mode 100644 index 000000000000..35eb3843bbb5 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationJobSchedule.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationjobschedule +schema: 2.0.0 +--- + +# New-AzAutomationJobSchedule + +## SYNOPSIS +Create a job schedule. + +## SYNTAX + +``` +New-AzAutomationJobSchedule -AutomationAccountName -Id -ResourceGroupName + [-SubscriptionId ] [-Parameter ] [-RunbookName ] [-RunOn ] + [-ScheduleName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a job schedule. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Id +The job schedule name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: JobScheduleId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Gets or sets a list of job properties. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +Gets or sets the name of the runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunOn +Gets or sets the hybrid worker group that the scheduled job should run on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleName +Gets or sets the name of the Schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IJobSchedule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationModule.md b/swaggerci/automation/docs/New-AzAutomationModule.md new file mode 100644 index 000000000000..56dfa30295f4 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationModule.md @@ -0,0 +1,277 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationmodule +schema: 2.0.0 +--- + +# New-AzAutomationModule + +## SYNOPSIS +Create or Update the module identified by module name. + +## SYNTAX + +``` +New-AzAutomationModule -AutomationAccountName -ModuleName -ResourceGroupName + [-SubscriptionId ] [-ContentHashAlgorithm ] [-ContentHashValue ] + [-ContentLinkUri ] [-ContentLinkVersion ] [-Location ] [-Name ] + [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create or Update the module identified by module name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentHashAlgorithm +Gets or sets the content hash algorithm used to hash the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentHashValue +Gets or sets expected hash value of the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentLinkUri +Gets or sets the uri of the runbook content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentLinkVersion +Gets or sets the version of the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Location +Gets or sets the location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleName +The name of module. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Tag +Gets or sets the tags attached to the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IModule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationPrivateEndpointConnection.md b/swaggerci/automation/docs/New-AzAutomationPrivateEndpointConnection.md new file mode 100644 index 000000000000..28d3160094b7 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationPrivateEndpointConnection.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationprivateendpointconnection +schema: 2.0.0 +--- + +# New-AzAutomationPrivateEndpointConnection + +## SYNOPSIS +Approve or reject a private endpoint connection with a given name. + +## SYNTAX + +``` +New-AzAutomationPrivateEndpointConnection -AutomationAccountName -Name + -ResourceGroupName [-SubscriptionId ] [-GroupId ] [-PrivateEndpointId ] + [-PrivateLinkServiceConnectionStateDescription ] [-PrivateLinkServiceConnectionStateStatus ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Approve or reject a private endpoint connection with a given name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -GroupId +Gets the groupIds. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +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 +``` + +### -PrivateEndpointId +Resource id of the private endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivateLinkServiceConnectionStateDescription +The private link service connection description. + +```yaml +Type: System.String +Parameter Sets: (All) +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: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180610.IPrivateEndpointConnection + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationPython2Package.md b/swaggerci/automation/docs/New-AzAutomationPython2Package.md new file mode 100644 index 000000000000..108ec469ec50 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationPython2Package.md @@ -0,0 +1,247 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationpython2package +schema: 2.0.0 +--- + +# New-AzAutomationPython2Package + +## SYNOPSIS +Create or Update the python 2 package identified by package name. + +## SYNTAX + +``` +New-AzAutomationPython2Package -AutomationAccountName -PackageName + -ResourceGroupName [-SubscriptionId ] [-ContentHashAlgorithm ] + [-ContentHashValue ] [-ContentLinkUri ] [-ContentLinkVersion ] [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create or Update the python 2 package identified by package name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentHashAlgorithm +Gets or sets the content hash algorithm used to hash the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentHashValue +Gets or sets expected hash value of the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentLinkUri +Gets or sets the uri of the runbook content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentLinkVersion +Gets or sets the version of the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -PackageName +The name of python package. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Tag +Gets or sets the tags attached to the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IModule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationRunbook.md b/swaggerci/automation/docs/New-AzAutomationRunbook.md new file mode 100644 index 000000000000..a5d0c0f52542 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationRunbook.md @@ -0,0 +1,493 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationrunbook +schema: 2.0.0 +--- + +# New-AzAutomationRunbook + +## SYNOPSIS +Create the runbook identified by runbook name. + +## SYNTAX + +``` +New-AzAutomationRunbook -AutomationAccountName -ResourceGroupName -RunbookName + -RunbookType [-SubscriptionId ] [-Description ] + [-DraftContentLinkContentHashAlgorithm ] [-DraftContentLinkContentHashValue ] + [-DraftContentLinkUri ] [-DraftContentLinkVersion ] [-DraftCreationTime ] + [-DraftInEdit] [-DraftLastModifiedTime ] [-DraftOutputType ] + [-DraftParameter ] [-Location ] [-LogActivityTrace ] [-LogProgress] [-LogVerbose] + [-Name ] [-PublishContentLinkContentHashAlgorithm ] + [-PublishContentLinkContentHashValue ] [-PublishContentLinkUri ] + [-PublishContentLinkVersion ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create the runbook identified by runbook name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DraftContentLinkContentHashAlgorithm +Gets or sets the content hash algorithm used to hash the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DraftContentLinkContentHashValue +Gets or sets expected hash value of the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DraftContentLinkUri +Gets or sets the uri of the runbook content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DraftContentLinkVersion +Gets or sets the version of the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DraftCreationTime +Gets or sets the creation time of the runbook draft. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DraftInEdit +Gets or sets whether runbook is in edit mode. + +```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 +``` + +### -DraftLastModifiedTime +Gets or sets the last modified time of the runbook draft. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DraftOutputType +Gets or sets the runbook output types. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DraftParameter +Gets or sets the runbook draft parameters. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Gets or sets the location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogActivityTrace +Gets or sets the activity-level tracing options of the runbook. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogProgress +Gets or sets progress log option. + +```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 +``` + +### -LogVerbose +Gets or sets verbose log option. + +```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 +``` + +### -Name +Gets or sets the name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishContentLinkContentHashAlgorithm +Gets or sets the content hash algorithm used to hash the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishContentLinkContentHashValue +Gets or sets expected hash value of the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishContentLinkUri +Gets or sets the uri of the runbook content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishContentLinkVersion +Gets or sets the version of the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +The runbook name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookType +Gets or sets the type of the runbook. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.RunbookTypeEnum +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Tag +Gets or sets the tags attached to the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180630.IRunbook + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationSchedule.md b/swaggerci/automation/docs/New-AzAutomationSchedule.md new file mode 100644 index 000000000000..b7aa8c8eb1b5 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationSchedule.md @@ -0,0 +1,350 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationschedule +schema: 2.0.0 +--- + +# New-AzAutomationSchedule + +## SYNOPSIS +Create a schedule. + +## SYNTAX + +``` +New-AzAutomationSchedule -AutomationAccountName -ResourceGroupName -ScheduleName + -Frequency -Name -StartTime [-SubscriptionId ] + [-AdvancedScheduleMonthDay ] + [-AdvancedScheduleMonthlyOccurrence ] + [-AdvancedScheduleWeekDay ] [-Description ] [-ExpiryTime ] [-Interval ] + [-TimeZone ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a schedule. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AdvancedScheduleMonthDay +Days of the month that the job should execute on. +Must be between 1 and 31. + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdvancedScheduleMonthlyOccurrence +Occurrences of days within a month. +To construct, see NOTES section for ADVANCEDSCHEDULEMONTHLYOCCURRENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.IAdvancedScheduleMonthlyOccurrence[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdvancedScheduleWeekDay +Days of the week that the job should execute on. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpiryTime +Gets or sets the end time of the schedule. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Frequency +Gets or sets the frequency of the schedule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.ScheduleFrequency +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Interval +Gets or sets the interval of the schedule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.IAny +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the Schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleName +The schedule name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +Gets or sets the start time of the schedule. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -TimeZone +Gets or sets the time zone of the schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ISchedule + +## NOTES + +ALIASES + +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. + + +ADVANCEDSCHEDULEMONTHLYOCCURRENCE : Occurrences of days within a month. + - `[Day ]`: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. + - `[Occurrence ]`: Occurrence of the week within the month. Must be between 1 and 5 + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationSoftwareUpdateConfiguration.md b/swaggerci/automation/docs/New-AzAutomationSoftwareUpdateConfiguration.md new file mode 100644 index 000000000000..9cfb59f5442c --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationSoftwareUpdateConfiguration.md @@ -0,0 +1,753 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationsoftwareupdateconfiguration +schema: 2.0.0 +--- + +# New-AzAutomationSoftwareUpdateConfiguration + +## SYNOPSIS +Create a new software update configuration with the name given in the URI. + +## SYNTAX + +``` +New-AzAutomationSoftwareUpdateConfiguration -AutomationAccountName -Name + -ResourceGroupName -UpdateConfigurationOperatingSystem + [-SubscriptionId ] [-ClientRequestId ] [-AdvancedScheduleMonthDay ] + [-AdvancedScheduleMonthlyOccurrence ] + [-AdvancedScheduleWeekDay ] [-Code ] [-LinuxExcludedPackageNameMask ] + [-LinuxIncludedPackageClassification ] [-LinuxIncludedPackageNameMask ] + [-LinuxRebootSetting ] [-Message ] [-PostTaskParameter ] + [-PostTaskSource ] [-PreTaskParameter ] [-PreTaskSource ] + [-ScheduleInfoCreationTime ] [-ScheduleInfoDescription ] + [-ScheduleInfoExpiryTime ] [-ScheduleInfoExpiryTimeOffsetMinute ] + [-ScheduleInfoFrequency ] [-ScheduleInfoInterval ] [-ScheduleInfoIsEnabled] + [-ScheduleInfoLastModifiedTime ] [-ScheduleInfoNextRun ] + [-ScheduleInfoNextRunOffsetMinute ] [-ScheduleInfoStartTime ] + [-ScheduleInfoTimeZone ] [-TargetAzureQuery ] + [-TargetNonAzureQuery ] [-UpdateConfigurationAzureVirtualMachine ] + [-UpdateConfigurationDuration ] [-UpdateConfigurationNonAzureComputerName ] + [-WindowExcludedKbNumber ] [-WindowIncludedKbNumber ] + [-WindowIncludedUpdateClassification ] [-WindowRebootSetting ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a new software update configuration with the name given in the URI. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AdvancedScheduleMonthDay +Days of the month that the job should execute on. +Must be between 1 and 31. + +```yaml +Type: System.Int32[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdvancedScheduleMonthlyOccurrence +Occurrences of days within a month. +To construct, see NOTES section for ADVANCEDSCHEDULEMONTHLYOCCURRENCE properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.IAdvancedScheduleMonthlyOccurrence[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdvancedScheduleWeekDay +Days of the week that the job should execute on. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Code +Error code + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -LinuxExcludedPackageNameMask +packages excluded from the software update configuration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinuxIncludedPackageClassification +Update classifications included in the software update configuration. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.LinuxUpdateClasses +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinuxIncludedPackageNameMask +packages included from the software update configuration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LinuxRebootSetting +Reboot setting for the software update configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Message +Error message indicating why the operation failed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the software update configuration to be created. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SoftwareUpdateConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostTaskParameter +Gets or sets the parameters of the task. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostTaskSource +Gets or sets the name of the runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreTaskParameter +Gets or sets the parameters of the task. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreTaskSource +Gets or sets the name of the runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoCreationTime +Gets or sets the creation time. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoDescription +Gets or sets the description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoExpiryTime +Gets or sets the end time of the schedule. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoExpiryTimeOffsetMinute +Gets or sets the expiry time's offset in minutes. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoFrequency +Gets or sets the frequency of the schedule. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.ScheduleFrequency +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoInterval +Gets or sets the interval of the schedule. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoIsEnabled +Gets or sets a value indicating whether this schedule is enabled. + +```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 +``` + +### -ScheduleInfoLastModifiedTime +Gets or sets the last modified time. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoNextRun +Gets or sets the next run time of the schedule. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoNextRunOffsetMinute +Gets or sets the next run time's offset in minutes. + +```yaml +Type: System.Double +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoStartTime +Gets or sets the start time of the schedule. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleInfoTimeZone +Gets or sets the time zone of the schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -TargetAzureQuery +List of Azure queries in the software update configuration. +To construct, see NOTES section for TARGETAZUREQUERY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.IAzureQueryProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNonAzureQuery +List of non Azure queries in the software update configuration. +To construct, see NOTES section for TARGETNONAZUREQUERY properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.INonAzureQueryProperties[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateConfigurationAzureVirtualMachine +List of azure resource Ids for azure virtual machines targeted by the software update configuration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateConfigurationDuration +Maximum time allowed for the software update configuration run. +Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601 + +```yaml +Type: System.TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateConfigurationNonAzureComputerName +List of names of non-azure machines targeted by the software update configuration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateConfigurationOperatingSystem +operating system of target machines + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.OperatingSystemType +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowExcludedKbNumber +KB numbers excluded from the software update configuration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowIncludedKbNumber +KB numbers included from the software update configuration. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowIncludedUpdateClassification +Update classification included in the software update configuration. +A comma separated string with required values + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.WindowsUpdateClasses +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WindowRebootSetting +Reboot setting for the software update configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20190601.ISoftwareUpdateConfiguration + +## NOTES + +ALIASES + +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. + + +ADVANCEDSCHEDULEMONTHLYOCCURRENCE : Occurrences of days within a month. + - `[Day ]`: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. + - `[Occurrence ]`: Occurrence of the week within the month. Must be between 1 and 5 + +TARGETAZUREQUERY : List of Azure queries in the software update configuration. + - `[Location ]`: List of locations to scope the query to. + - `[Scope ]`: List of Subscription or Resource Group ARM Ids. + - `[TagSettingFilterOperator ]`: Filter VMs by Any or All specified tags. + - `[TagSettingTag ]`: Dictionary of tags with its list of values. + - `[(Any) ]`: This indicates any property can be added to this object. + +TARGETNONAZUREQUERY : List of non Azure queries in the software update configuration. + - `[FunctionAlias ]`: Log Analytics Saved Search name. + - `[WorkspaceId ]`: Workspace Id for Log Analytics in which the saved Search is resided. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationSourceControl.md b/swaggerci/automation/docs/New-AzAutomationSourceControl.md new file mode 100644 index 000000000000..ea3d012b3458 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationSourceControl.md @@ -0,0 +1,329 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationsourcecontrol +schema: 2.0.0 +--- + +# New-AzAutomationSourceControl + +## SYNOPSIS +Create a source control. + +## SYNTAX + +``` +New-AzAutomationSourceControl -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-AutoSync] [-Branch ] [-Description ] [-FolderPath ] + [-PublishRunbook] [-RepoUrl ] [-SecurityTokenAccessToken ] + [-SecurityTokenRefreshToken ] [-SecurityTokenType ] [-SourceType ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a source control. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoSync +The auto async of the source control. +Default is false. + +```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 +``` + +### -Branch +The repo branch of the source control. +Include branch as empty string for VsoTfvc. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +The user description of the source control. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FolderPath +The folder path of the source control. +Path must be relative. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The source control name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SourceControlName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishRunbook +The auto publish of the source control. +Default is true. + +```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 +``` + +### -RepoUrl +The repo url of the source control. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityTokenAccessToken +The access token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityTokenRefreshToken +The refresh token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityTokenType +The token type. +Must be either PersonalAccessToken or Oauth. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.TokenType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceType +The source type. +Must be one of VsoGit, VsoTfvc, GitHub, case sensitive. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.SourceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ISourceControl + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationSourceControlSyncJob.md b/swaggerci/automation/docs/New-AzAutomationSourceControlSyncJob.md new file mode 100644 index 000000000000..348eb31b104e --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationSourceControlSyncJob.md @@ -0,0 +1,202 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationsourcecontrolsyncjob +schema: 2.0.0 +--- + +# New-AzAutomationSourceControlSyncJob + +## SYNOPSIS +Creates the sync job for a source control. + +## SYNTAX + +``` +New-AzAutomationSourceControlSyncJob -AutomationAccountName -Id -ResourceGroupName + -SourceControlName -CommitId [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates the sync job for a source control. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommitId +The commit id of the source control sync job. +If not syncing to a commitId, enter an empty string. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Id +The source control sync job id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: SourceControlSyncJobId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceControlName +The source control name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ISourceControlSyncJob + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationTestJob.md b/swaggerci/automation/docs/New-AzAutomationTestJob.md new file mode 100644 index 000000000000..e0fd94d2c349 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationTestJob.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationtestjob +schema: 2.0.0 +--- + +# New-AzAutomationTestJob + +## SYNOPSIS +Create a test job of the runbook. + +## SYNTAX + +``` +New-AzAutomationTestJob -AutomationAccountName -ResourceGroupName -RunbookName + [-SubscriptionId ] [-Parameter ] [-RunOn ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create a test job of the runbook. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Parameter +Gets or sets the parameters of the test job. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +The parameters supplied to the create test job operation. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunOn +Gets or sets the runOn which specifies the group name where the job is to be executed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180630.ITestJob + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationVariable.md b/swaggerci/automation/docs/New-AzAutomationVariable.md new file mode 100644 index 000000000000..2569f5f01d2b --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationVariable.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationvariable +schema: 2.0.0 +--- + +# New-AzAutomationVariable + +## SYNOPSIS +Create a variable. + +## SYNTAX + +``` +New-AzAutomationVariable -AutomationAccountName -ResourceGroupName -VariableName + -Name [-SubscriptionId ] [-Description ] [-IsEncrypted] [-Value ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a variable. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsEncrypted +Gets or sets the encrypted flag of the variable. + +```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 +``` + +### -Name +Gets or sets the name of the variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Value +Gets or sets the value of the variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VariableName +The variable name. + +```yaml +Type: System.String +Parameter Sets: (All) +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. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IVariable + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationWatcher.md b/swaggerci/automation/docs/New-AzAutomationWatcher.md new file mode 100644 index 000000000000..c767e6e68e9b --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationWatcher.md @@ -0,0 +1,293 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationwatcher +schema: 2.0.0 +--- + +# New-AzAutomationWatcher + +## SYNOPSIS +Create the watcher identified by watcher name. + +## SYNTAX + +``` +New-AzAutomationWatcher -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-Description ] [-Etag ] [-ExecutionFrequencyInSecond ] + [-Location ] [-ScriptName ] [-ScriptParameter ] [-ScriptRunOn ] + [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create the watcher identified by watcher name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Etag +Gets or sets the etag of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExecutionFrequencyInSecond +Gets or sets the frequency at which the watcher is invoked. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The watcher name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: WatcherName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptName +Gets or sets the name of the script the watcher is attached to, i.e. +the name of an existing runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptParameter +Gets or sets the parameters of the script. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScriptRunOn +Gets or sets the name of the hybrid worker group the watcher will run on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IWatcher + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationWebhook.md b/swaggerci/automation/docs/New-AzAutomationWebhook.md new file mode 100644 index 000000000000..711fcbbf9ea2 --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationWebhook.md @@ -0,0 +1,277 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationwebhook +schema: 2.0.0 +--- + +# New-AzAutomationWebhook + +## SYNOPSIS +Create the webhook identified by webhook name. + +## SYNTAX + +``` +New-AzAutomationWebhook -AutomationAccountName -ResourceGroupName -WebhookName + -Name [-SubscriptionId ] [-ExpiryTime ] [-IsEnabled] [-Parameter ] + [-RunbookName ] [-RunOn ] [-Uri ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create the webhook identified by webhook name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -ExpiryTime +Gets or sets the expiry time. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsEnabled +Gets or sets the value of the enabled flag of webhook. + +```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 +``` + +### -Name +Gets or sets the name of the webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Gets or sets the parameters of the job. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +Gets or sets the name of the runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunOn +Gets or sets the name of the hybrid worker group the webhook job will run on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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 +``` + +### -Uri +Gets or sets the uri. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebhookName +The webhook name. + +```yaml +Type: System.String +Parameter Sets: (All) +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. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20151031.IWebhook + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/New-AzAutomationWebhookUri.md b/swaggerci/automation/docs/New-AzAutomationWebhookUri.md new file mode 100644 index 000000000000..73720749e10b --- /dev/null +++ b/swaggerci/automation/docs/New-AzAutomationWebhookUri.md @@ -0,0 +1,223 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/new-azautomationwebhookuri +schema: 2.0.0 +--- + +# New-AzAutomationWebhookUri + +## SYNOPSIS +Generates a Uri for use in creating a webhook. + +## SYNTAX + +### Generate (Default) +``` +New-AzAutomationWebhookUri -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### GenerateViaIdentity +``` +New-AzAutomationWebhookUri -InputObject [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Generates a Uri for use in creating a webhook. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Generate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: GenerateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Generate +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Generate +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.String + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Publish-AzAutomationRunbook.md b/swaggerci/automation/docs/Publish-AzAutomationRunbook.md new file mode 100644 index 000000000000..2064a2b2569c --- /dev/null +++ b/swaggerci/automation/docs/Publish-AzAutomationRunbook.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/publish-azautomationrunbook +schema: 2.0.0 +--- + +# Publish-AzAutomationRunbook + +## SYNOPSIS +Publish runbook draft. + +## SYNTAX + +### Publish (Default) +``` +Publish-AzAutomationRunbook -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### PublishViaIdentity +``` +Publish-AzAutomationRunbook -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Publish runbook draft. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Publish +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: PublishViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The parameters supplied to the publish runbook operation. + +```yaml +Type: System.String +Parameter Sets: Publish +Aliases: RunbookName + +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 +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Publish +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Publish +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/README.md b/swaggerci/automation/docs/README.md new file mode 100644 index 000000000000..e2a2439e313c --- /dev/null +++ b/swaggerci/automation/docs/README.md @@ -0,0 +1,11 @@ +# Docs +This directory contains the documentation of the cmdlets for the `Az.Automation` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `../examples` folder. + +## Info +- Modifiable: no +- Generated: all +- Committed: yes +- Packaged: yes + +## Details +The process of documentation generation loads `Az.Automation` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder. \ No newline at end of file diff --git a/swaggerci/automation/docs/Remove-AzAutomationAccount.md b/swaggerci/automation/docs/Remove-AzAutomationAccount.md new file mode 100644 index 000000000000..2f035be1330b --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationAccount.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationaccount +schema: 2.0.0 +--- + +# Remove-AzAutomationAccount + +## SYNOPSIS +Delete an automation account. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationAccount -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationAccount -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete an automation account. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +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 automation account. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AutomationAccountName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationCertificate.md b/swaggerci/automation/docs/Remove-AzAutomationCertificate.md new file mode 100644 index 000000000000..6fc5abf54ef0 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationCertificate.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationcertificate +schema: 2.0.0 +--- + +# Remove-AzAutomationCertificate + +## SYNOPSIS +Delete the certificate. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationCertificate -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationCertificate -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the certificate. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of certificate. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CertificateName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationConnection.md b/swaggerci/automation/docs/Remove-AzAutomationConnection.md new file mode 100644 index 000000000000..cc2d6462eb09 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationConnection.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationconnection +schema: 2.0.0 +--- + +# Remove-AzAutomationConnection + +## SYNOPSIS +Delete the connection. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationConnection -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationConnection -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the connection. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of connection. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ConnectionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationConnectionType.md b/swaggerci/automation/docs/Remove-AzAutomationConnectionType.md new file mode 100644 index 000000000000..6a631b4ff19e --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationConnectionType.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationconnectiontype +schema: 2.0.0 +--- + +# Remove-AzAutomationConnectionType + +## SYNOPSIS +Delete the connection type. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationConnectionType -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationConnectionType -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the connection type. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of connection type. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ConnectionTypeName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationCredential.md b/swaggerci/automation/docs/Remove-AzAutomationCredential.md new file mode 100644 index 000000000000..daa45fa647d7 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationCredential.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationcredential +schema: 2.0.0 +--- + +# Remove-AzAutomationCredential + +## SYNOPSIS +Delete the credential. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationCredential -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationCredential -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the credential. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of credential. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: CredentialName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationDscConfiguration.md b/swaggerci/automation/docs/Remove-AzAutomationDscConfiguration.md new file mode 100644 index 000000000000..f0b195a889ef --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationDscConfiguration.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationdscconfiguration +schema: 2.0.0 +--- + +# Remove-AzAutomationDscConfiguration + +## SYNOPSIS +Delete the dsc configuration identified by configuration name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationDscConfiguration -AutomationAccountName -ConfigurationName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationDscConfiguration -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the dsc configuration identified by configuration name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConfigurationName +The configuration name. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationDscNode.md b/swaggerci/automation/docs/Remove-AzAutomationDscNode.md new file mode 100644 index 000000000000..0d281832d9bc --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationDscNode.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationdscnode +schema: 2.0.0 +--- + +# Remove-AzAutomationDscNode + +## SYNOPSIS +Delete the dsc node identified by node id. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationDscNode -AutomationAccountName -NodeId -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationDscNode -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the dsc node identified by node id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NodeId +The node id. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationDscNodeConfiguration.md b/swaggerci/automation/docs/Remove-AzAutomationDscNodeConfiguration.md new file mode 100644 index 000000000000..4fe1422abb49 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationDscNodeConfiguration.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationdscnodeconfiguration +schema: 2.0.0 +--- + +# Remove-AzAutomationDscNodeConfiguration + +## SYNOPSIS +Delete the Dsc node configurations by node configuration. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationDscNodeConfiguration -AutomationAccountName -NodeConfigurationName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationDscNodeConfiguration -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the Dsc node configurations by node configuration. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NodeConfigurationName +The Dsc node configuration name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationHybridRunbookWorker.md b/swaggerci/automation/docs/Remove-AzAutomationHybridRunbookWorker.md new file mode 100644 index 000000000000..a194282ca89e --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationHybridRunbookWorker.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationhybridrunbookworker +schema: 2.0.0 +--- + +# Remove-AzAutomationHybridRunbookWorker + +## SYNOPSIS +Delete a hybrid runbook worker. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationHybridRunbookWorker -AutomationAccountName -GroupName -Id + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationHybridRunbookWorker -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a hybrid runbook worker. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -GroupName +The hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: HybridRunbookWorkerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +The hybrid runbook worker id + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: HybridRunbookWorkerId + +Required: True +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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationHybridRunbookWorkerGroup.md b/swaggerci/automation/docs/Remove-AzAutomationHybridRunbookWorkerGroup.md new file mode 100644 index 000000000000..088416da9481 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationHybridRunbookWorkerGroup.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationhybridrunbookworkergroup +schema: 2.0.0 +--- + +# Remove-AzAutomationHybridRunbookWorkerGroup + +## SYNOPSIS +Delete a hybrid runbook worker group. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationHybridRunbookWorkerGroup -AutomationAccountName -Name + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationHybridRunbookWorkerGroup -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a hybrid runbook worker group. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: HybridRunbookWorkerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationJobSchedule.md b/swaggerci/automation/docs/Remove-AzAutomationJobSchedule.md new file mode 100644 index 000000000000..cdec02aece4a --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationJobSchedule.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationjobschedule +schema: 2.0.0 +--- + +# Remove-AzAutomationJobSchedule + +## SYNOPSIS +Delete the job schedule identified by job schedule name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationJobSchedule -AutomationAccountName -Id -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationJobSchedule -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the job schedule identified by job schedule name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Id +The job schedule name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: JobScheduleId + +Required: True +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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationModule.md b/swaggerci/automation/docs/Remove-AzAutomationModule.md new file mode 100644 index 000000000000..5549a2a1a4f9 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationModule.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationmodule +schema: 2.0.0 +--- + +# Remove-AzAutomationModule + +## SYNOPSIS +Delete the module by name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationModule -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationModule -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the module by name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The module name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ModuleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationPrivateEndpointConnection.md b/swaggerci/automation/docs/Remove-AzAutomationPrivateEndpointConnection.md new file mode 100644 index 000000000000..2e8811a9988c --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationPrivateEndpointConnection.md @@ -0,0 +1,284 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationprivateendpointconnection +schema: 2.0.0 +--- + +# Remove-AzAutomationPrivateEndpointConnection + +## SYNOPSIS +Deletes a private endpoint connection with a given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationPrivateEndpointConnection -AutomationAccountName -Name + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationPrivateEndpointConnection -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a private endpoint connection with a given name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationPython2Package.md b/swaggerci/automation/docs/Remove-AzAutomationPython2Package.md new file mode 100644 index 000000000000..2bfc9a822e54 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationPython2Package.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationpython2package +schema: 2.0.0 +--- + +# Remove-AzAutomationPython2Package + +## SYNOPSIS +Delete the python 2 package by name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationPython2Package -AutomationAccountName -PackageName + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationPython2Package -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the python 2 package by name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PackageName +The python package name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationRunbook.md b/swaggerci/automation/docs/Remove-AzAutomationRunbook.md new file mode 100644 index 000000000000..67501bf56494 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationRunbook.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationrunbook +schema: 2.0.0 +--- + +# Remove-AzAutomationRunbook + +## SYNOPSIS +Delete the runbook by name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationRunbook -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationRunbook -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the runbook by name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The runbook name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: RunbookName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationSchedule.md b/swaggerci/automation/docs/Remove-AzAutomationSchedule.md new file mode 100644 index 000000000000..eff3d2f53471 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationSchedule.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationschedule +schema: 2.0.0 +--- + +# Remove-AzAutomationSchedule + +## SYNOPSIS +Delete the schedule identified by schedule name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationSchedule -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationSchedule -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the schedule identified by schedule name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The schedule name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ScheduleName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationSoftwareUpdateConfiguration.md b/swaggerci/automation/docs/Remove-AzAutomationSoftwareUpdateConfiguration.md new file mode 100644 index 000000000000..7af8d953d013 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationSoftwareUpdateConfiguration.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationsoftwareupdateconfiguration +schema: 2.0.0 +--- + +# Remove-AzAutomationSoftwareUpdateConfiguration + +## SYNOPSIS +delete a specific software update configuration. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationSoftwareUpdateConfiguration -AutomationAccountName -Name + -ResourceGroupName [-SubscriptionId ] [-ClientRequestId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationSoftwareUpdateConfiguration -InputObject [-ClientRequestId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +delete a specific software update configuration. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +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 software update configuration to be created. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SoftwareUpdateConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationSourceControl.md b/swaggerci/automation/docs/Remove-AzAutomationSourceControl.md new file mode 100644 index 000000000000..5ecd5af602ef --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationSourceControl.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationsourcecontrol +schema: 2.0.0 +--- + +# Remove-AzAutomationSourceControl + +## SYNOPSIS +Delete the source control. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationSourceControl -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationSourceControl -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the source control. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of source control. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: SourceControlName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationVariable.md b/swaggerci/automation/docs/Remove-AzAutomationVariable.md new file mode 100644 index 000000000000..5e0fd1f988d8 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationVariable.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationvariable +schema: 2.0.0 +--- + +# Remove-AzAutomationVariable + +## SYNOPSIS +Delete the variable. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationVariable -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationVariable -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the variable. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of variable. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: VariableName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationWatcher.md b/swaggerci/automation/docs/Remove-AzAutomationWatcher.md new file mode 100644 index 000000000000..72d030d7a775 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationWatcher.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationwatcher +schema: 2.0.0 +--- + +# Remove-AzAutomationWatcher + +## SYNOPSIS +Delete the watcher by name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationWatcher -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationWatcher -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the watcher by name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The watcher name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: WatcherName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Remove-AzAutomationWebhook.md b/swaggerci/automation/docs/Remove-AzAutomationWebhook.md new file mode 100644 index 000000000000..6ea04ba2f360 --- /dev/null +++ b/swaggerci/automation/docs/Remove-AzAutomationWebhook.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/remove-azautomationwebhook +schema: 2.0.0 +--- + +# Remove-AzAutomationWebhook + +## SYNOPSIS +Delete the webhook by name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzAutomationWebhook -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzAutomationWebhook -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete the webhook by name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```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 credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The webhook name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: WebhookName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Resume-AzAutomationJob.md b/swaggerci/automation/docs/Resume-AzAutomationJob.md new file mode 100644 index 000000000000..89017f4683fc --- /dev/null +++ b/swaggerci/automation/docs/Resume-AzAutomationJob.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/resume-azautomationjob +schema: 2.0.0 +--- + +# Resume-AzAutomationJob + +## SYNOPSIS +Resume the job identified by jobName. + +## SYNTAX + +### Resume (Default) +``` +Resume-AzAutomationJob -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-ClientRequestId ] [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### ResumeViaIdentity +``` +Resume-AzAutomationJob -InputObject [-ClientRequestId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Resume the job identified by jobName. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: ResumeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The job name. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Resume +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Resume-AzAutomationTestJob.md b/swaggerci/automation/docs/Resume-AzAutomationTestJob.md new file mode 100644 index 000000000000..f65365c08ee0 --- /dev/null +++ b/swaggerci/automation/docs/Resume-AzAutomationTestJob.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/resume-azautomationtestjob +schema: 2.0.0 +--- + +# Resume-AzAutomationTestJob + +## SYNOPSIS +Resume the test job. + +## SYNTAX + +### Resume (Default) +``` +Resume-AzAutomationTestJob -AutomationAccountName -ResourceGroupName -RunbookName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### ResumeViaIdentity +``` +Resume-AzAutomationTestJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Resume the test job. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: ResumeViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +The runbook name. + +```yaml +Type: System.String +Parameter Sets: Resume +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Resume +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Start-AzAutomationWatcher.md b/swaggerci/automation/docs/Start-AzAutomationWatcher.md new file mode 100644 index 000000000000..c8db5b50c3d3 --- /dev/null +++ b/swaggerci/automation/docs/Start-AzAutomationWatcher.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/start-azautomationwatcher +schema: 2.0.0 +--- + +# Start-AzAutomationWatcher + +## SYNOPSIS +Resume the watcher identified by watcher name. + +## SYNTAX + +### Start (Default) +``` +Start-AzAutomationWatcher -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StartViaIdentity +``` +Start-AzAutomationWatcher -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Resume the watcher identified by watcher name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The watcher name. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: WatcherName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Start +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Stop-AzAutomationJob.md b/swaggerci/automation/docs/Stop-AzAutomationJob.md new file mode 100644 index 000000000000..86089d6ae8e9 --- /dev/null +++ b/swaggerci/automation/docs/Stop-AzAutomationJob.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/stop-azautomationjob +schema: 2.0.0 +--- + +# Stop-AzAutomationJob + +## SYNOPSIS +Stop the job identified by jobName. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzAutomationJob -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-ClientRequestId ] [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### StopViaIdentity +``` +Stop-AzAutomationJob -InputObject [-ClientRequestId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Stop the job identified by jobName. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The job name. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Stop +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Stop-AzAutomationTestJob.md b/swaggerci/automation/docs/Stop-AzAutomationTestJob.md new file mode 100644 index 000000000000..f8d73ee271b3 --- /dev/null +++ b/swaggerci/automation/docs/Stop-AzAutomationTestJob.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/stop-azautomationtestjob +schema: 2.0.0 +--- + +# Stop-AzAutomationTestJob + +## SYNOPSIS +Stop the test job. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzAutomationTestJob -AutomationAccountName -ResourceGroupName -RunbookName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentity +``` +Stop-AzAutomationTestJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Stop the test job. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +The runbook name. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Stop +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Stop-AzAutomationWatcher.md b/swaggerci/automation/docs/Stop-AzAutomationWatcher.md new file mode 100644 index 000000000000..a2cbe9afdc98 --- /dev/null +++ b/swaggerci/automation/docs/Stop-AzAutomationWatcher.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/stop-azautomationwatcher +schema: 2.0.0 +--- + +# Stop-AzAutomationWatcher + +## SYNOPSIS +Resume the watcher identified by watcher name. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzAutomationWatcher -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentity +``` +Stop-AzAutomationWatcher -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Resume the watcher identified by watcher name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The watcher name. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: WatcherName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Stop +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Suspend-AzAutomationJob.md b/swaggerci/automation/docs/Suspend-AzAutomationJob.md new file mode 100644 index 000000000000..5b3377f1ac7c --- /dev/null +++ b/swaggerci/automation/docs/Suspend-AzAutomationJob.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/suspend-azautomationjob +schema: 2.0.0 +--- + +# Suspend-AzAutomationJob + +## SYNOPSIS +Suspend the job identified by job name. + +## SYNTAX + +### Suspend (Default) +``` +Suspend-AzAutomationJob -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-ClientRequestId ] [-DefaultProfile ] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### SuspendViaIdentity +``` +Suspend-AzAutomationJob -InputObject [-ClientRequestId ] + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Suspend the job identified by job name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Suspend +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientRequestId +Identifies this specific client request. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: SuspendViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The job name. + +```yaml +Type: System.String +Parameter Sets: Suspend +Aliases: JobName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Suspend +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Suspend +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Suspend-AzAutomationTestJob.md b/swaggerci/automation/docs/Suspend-AzAutomationTestJob.md new file mode 100644 index 000000000000..2067715bb6e4 --- /dev/null +++ b/swaggerci/automation/docs/Suspend-AzAutomationTestJob.md @@ -0,0 +1,253 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/suspend-azautomationtestjob +schema: 2.0.0 +--- + +# Suspend-AzAutomationTestJob + +## SYNOPSIS +Suspend the test job. + +## SYNTAX + +### Suspend (Default) +``` +Suspend-AzAutomationTestJob -AutomationAccountName -ResourceGroupName -RunbookName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### SuspendViaIdentity +``` +Suspend-AzAutomationTestJob -InputObject [-DefaultProfile ] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Suspend the test job. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Suspend +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: SuspendViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Suspend +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +The runbook name. + +```yaml +Type: System.String +Parameter Sets: Suspend +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Suspend +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Undo-AzAutomationRunbookDraftEdit.md b/swaggerci/automation/docs/Undo-AzAutomationRunbookDraftEdit.md new file mode 100644 index 000000000000..ccb6ef740994 --- /dev/null +++ b/swaggerci/automation/docs/Undo-AzAutomationRunbookDraftEdit.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/undo-azautomationrunbookdraftedit +schema: 2.0.0 +--- + +# Undo-AzAutomationRunbookDraftEdit + +## SYNOPSIS +Undo draft edit to last known published state identified by runbook name. + +## SYNTAX + +### Undo (Default) +``` +Undo-AzAutomationRunbookDraftEdit -AutomationAccountName -ResourceGroupName + -RunbookName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UndoViaIdentity +``` +Undo-AzAutomationRunbookDraftEdit -InputObject [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Undo draft edit to last known published state identified by runbook name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: Undo +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: UndoViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: Undo +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +The runbook name. + +```yaml +Type: System.String +Parameter Sets: Undo +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: Undo +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180630.IRunbookDraftUndoEditResult + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationAccount.md b/swaggerci/automation/docs/Update-AzAutomationAccount.md new file mode 100644 index 000000000000..aa6dd585866e --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationAccount.md @@ -0,0 +1,461 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationaccount +schema: 2.0.0 +--- + +# Update-AzAutomationAccount + +## SYNOPSIS +Update an automation account. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationAccount -AutomationAccountName -ResourceGroupName + [-SubscriptionId ] [-DisableLocalAuth] [-EncryptionKeySource ] + [-IdentityType ] [-IdentityUserAssignedIdentity ] + [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyvaultUri ] + [-KeyVaultPropertyKeyVersion ] [-Location ] [-Name ] + [-PropertiesEncryptionIdentityUserAssignedIdentity ] [-PublicNetworkAccess] [-SkuCapacity ] + [-SkuFamily ] [-SkuName ] [-Tag ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationAccount -InputObject [-DisableLocalAuth] + [-EncryptionKeySource ] [-IdentityType ] + [-IdentityUserAssignedIdentity ] [-KeyVaultPropertyKeyName ] + [-KeyVaultPropertyKeyvaultUri ] [-KeyVaultPropertyKeyVersion ] [-Location ] + [-Name ] [-PropertiesEncryptionIdentityUserAssignedIdentity ] [-PublicNetworkAccess] + [-SkuCapacity ] [-SkuFamily ] [-SkuName ] [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update an automation account. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -DisableLocalAuth +Indicates whether requests using non-AAD authentication are blocked + +```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 +``` + +### -EncryptionKeySource +Encryption Key Source + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.EncryptionKeySourceType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityUserAssignedIdentity +The list of user identities associated with the resource. +The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyName +The name of key used to encrypt data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyvaultUri +The URI of the key vault key used to encrypt data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyVaultPropertyKeyVersion +The key version of the key used to encrypt data. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +Gets or sets the location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertiesEncryptionIdentityUserAssignedIdentity +The user identity used for CMK. +It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.IAny +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet + +```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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuCapacity +Gets or sets the SKU capacity. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuFamily +Gets or sets the SKU family. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Gets or sets the SKU name of the account. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.SkuNameEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets the tags attached to the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IAutomationAccount + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationCertificate.md b/swaggerci/automation/docs/Update-AzAutomationCertificate.md new file mode 100644 index 000000000000..5a0248026e8d --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationCertificate.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationcertificate +schema: 2.0.0 +--- + +# Update-AzAutomationCertificate + +## SYNOPSIS +Update a certificate. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationCertificate -AutomationAccountName -CertificateName + -ResourceGroupName [-SubscriptionId ] [-Description ] [-Name ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationCertificate -InputObject [-Description ] [-Name ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a certificate. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateName +The parameters supplied to the update certificate operation. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the certificate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ICertificate + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationConnection.md b/swaggerci/automation/docs/Update-AzAutomationConnection.md new file mode 100644 index 000000000000..87482abad48f --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationConnection.md @@ -0,0 +1,286 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationconnection +schema: 2.0.0 +--- + +# Update-AzAutomationConnection + +## SYNOPSIS +Update a connection. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationConnection -AutomationAccountName -ConnectionName + -ResourceGroupName [-SubscriptionId ] [-Description ] + [-FieldDefinitionValue ] [-Name ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationConnection -InputObject [-Description ] + [-FieldDefinitionValue ] [-Name ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update a connection. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ConnectionName +The parameters supplied to the update a connection operation. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FieldDefinitionValue +Gets or sets the field definition values of the connection. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the connection. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IConnection + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationCredential.md b/swaggerci/automation/docs/Update-AzAutomationCredential.md new file mode 100644 index 000000000000..7d95a0f42b5b --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationCredential.md @@ -0,0 +1,301 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationcredential +schema: 2.0.0 +--- + +# Update-AzAutomationCredential + +## SYNOPSIS +Update a credential. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationCredential -AutomationAccountName -CredentialName + -ResourceGroupName [-SubscriptionId ] [-Description ] [-Name ] + [-Password ] [-UserName ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationCredential -InputObject [-Description ] [-Name ] + [-Password ] [-UserName ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update a credential. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialName +The parameters supplied to the Update credential operation. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Gets or sets the password of the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserName +Gets or sets the user name of the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ICredential + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationDscNode.md b/swaggerci/automation/docs/Update-AzAutomationDscNode.md new file mode 100644 index 000000000000..5d67aae3c236 --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationDscNode.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationdscnode +schema: 2.0.0 +--- + +# Update-AzAutomationDscNode + +## SYNOPSIS +Update the dsc node. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationDscNode -AutomationAccountName -NodeId -ResourceGroupName + [-SubscriptionId ] [-NodeConfigurationName ] [-NodeId1 ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationDscNode -InputObject [-NodeId ] + [-NodeConfigurationName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update the dsc node. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -NodeConfigurationName +Gets or sets the name of the dsc node configuration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeId +Parameters supplied to the update dsc node. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NodeId1 +Gets or sets the id of the dsc node. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IDscNode + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationHybridRunbookWorkerGroup.md b/swaggerci/automation/docs/Update-AzAutomationHybridRunbookWorkerGroup.md new file mode 100644 index 000000000000..c9bacc885322 --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationHybridRunbookWorkerGroup.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationhybridrunbookworkergroup +schema: 2.0.0 +--- + +# Update-AzAutomationHybridRunbookWorkerGroup + +## SYNOPSIS +Update a hybrid runbook worker group. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationHybridRunbookWorkerGroup -AutomationAccountName -Name + -ResourceGroupName [-SubscriptionId ] [-CredentialName ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationHybridRunbookWorkerGroup -InputObject [-CredentialName ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a hybrid runbook worker group. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialName +Gets or sets the name of the credential. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The hybrid runbook worker group name + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: HybridRunbookWorkerGroupName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20210622.IHybridRunbookWorkerGroup + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationModule.md b/swaggerci/automation/docs/Update-AzAutomationModule.md new file mode 100644 index 000000000000..baddd1d740e3 --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationModule.md @@ -0,0 +1,346 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationmodule +schema: 2.0.0 +--- + +# Update-AzAutomationModule + +## SYNOPSIS +Update the module identified by module name. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationModule -AutomationAccountName -ModuleName -ResourceGroupName + [-SubscriptionId ] [-ContentHashAlgorithm ] [-ContentHashValue ] + [-ContentLinkUri ] [-ContentLinkVersion ] [-Location ] [-Name ] + [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationModule -InputObject [-ContentHashAlgorithm ] + [-ContentHashValue ] [-ContentLinkUri ] [-ContentLinkVersion ] [-Location ] + [-Name ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update the module identified by module name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentHashAlgorithm +Gets or sets the content hash algorithm used to hash the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentHashValue +Gets or sets expected hash value of the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentLinkUri +Gets or sets the uri of the runbook content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentLinkVersion +Gets or sets the version of the content. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Gets or sets the location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleName +The name of module. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Gets or sets name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets the tags attached to the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IModule + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationPython2Package.md b/swaggerci/automation/docs/Update-AzAutomationPython2Package.md new file mode 100644 index 000000000000..67409315ce05 --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationPython2Package.md @@ -0,0 +1,254 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationpython2package +schema: 2.0.0 +--- + +# Update-AzAutomationPython2Package + +## SYNOPSIS +Update the python 2 package identified by package name. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationPython2Package -AutomationAccountName -PackageName + -ResourceGroupName [-SubscriptionId ] [-Tag ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationPython2Package -InputObject [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update the python 2 package identified by package name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PackageName +The name of python package. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets the tags attached to the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IModule + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationRunbook.md b/swaggerci/automation/docs/Update-AzAutomationRunbook.md new file mode 100644 index 000000000000..2db371004172 --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationRunbook.md @@ -0,0 +1,346 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationrunbook +schema: 2.0.0 +--- + +# Update-AzAutomationRunbook + +## SYNOPSIS +Update the runbook identified by runbook name. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationRunbook -AutomationAccountName -ResourceGroupName -RunbookName + [-SubscriptionId ] [-Description ] [-Location ] [-LogActivityTrace ] + [-LogProgress] [-LogVerbose] [-Name ] [-Tag ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationRunbook -InputObject [-Description ] [-Location ] + [-LogActivityTrace ] [-LogProgress] [-LogVerbose] [-Name ] [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update the runbook identified by runbook name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the runbook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +Gets or sets the location of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogActivityTrace +Gets or sets the activity-level tracing options of the runbook. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogProgress +Gets or sets progress log option. + +```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 +``` + +### -LogVerbose +Gets or sets verbose log option. + +```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 +``` + +### -Name +Gets or sets the name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunbookName +The runbook name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Gets or sets the tags attached to the resource. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20180630.IRunbook + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationSchedule.md b/swaggerci/automation/docs/Update-AzAutomationSchedule.md new file mode 100644 index 000000000000..842105d0b7cb --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationSchedule.md @@ -0,0 +1,284 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationschedule +schema: 2.0.0 +--- + +# Update-AzAutomationSchedule + +## SYNOPSIS +Update the schedule identified by schedule name. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationSchedule -AutomationAccountName -ResourceGroupName -ScheduleName + [-SubscriptionId ] [-Description ] [-IsEnabled] [-Name ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationSchedule -InputObject [-Description ] [-IsEnabled] + [-Name ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update the schedule identified by schedule name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsEnabled +Gets or sets a value indicating whether this schedule is enabled. + +```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 +``` + +### -Name +Gets or sets the name of the Schedule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScheduleName +The schedule name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ISchedule + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationSourceControl.md b/swaggerci/automation/docs/Update-AzAutomationSourceControl.md new file mode 100644 index 000000000000..9aab7e22996c --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationSourceControl.md @@ -0,0 +1,366 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationsourcecontrol +schema: 2.0.0 +--- + +# Update-AzAutomationSourceControl + +## SYNOPSIS +Update a source control. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationSourceControl -AutomationAccountName -Name -ResourceGroupName + [-SubscriptionId ] [-AutoSync] [-Branch ] [-Description ] [-FolderPath ] + [-PublishRunbook] [-SecurityTokenAccessToken ] [-SecurityTokenRefreshToken ] + [-SecurityTokenType ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationSourceControl -InputObject [-AutoSync] [-Branch ] + [-Description ] [-FolderPath ] [-PublishRunbook] [-SecurityTokenAccessToken ] + [-SecurityTokenRefreshToken ] [-SecurityTokenType ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a source control. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoSync +The auto sync of the source control. +Default is false. + +```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 +``` + +### -Branch +The repo branch of the source control. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +The user description of the source control. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FolderPath +The folder path of the source control. +Path must be relative. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The source control name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: SourceControlName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishRunbook +The auto publish of the source control. +Default is true. + +```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 +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityTokenAccessToken +The access token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityTokenRefreshToken +The refresh token. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecurityTokenType +The token type. +Must be either PersonalAccessToken or Oauth. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.Automation.Support.TokenType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.ISourceControl + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationVariable.md b/swaggerci/automation/docs/Update-AzAutomationVariable.md new file mode 100644 index 000000000000..e1409042c8dc --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationVariable.md @@ -0,0 +1,284 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationvariable +schema: 2.0.0 +--- + +# Update-AzAutomationVariable + +## SYNOPSIS +Update a variable. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationVariable -AutomationAccountName -ResourceGroupName -VariableName + [-SubscriptionId ] [-Description ] [-Name ] [-Value ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationVariable -InputObject [-Description ] [-Name ] + [-Value ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a variable. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Gets or sets the value of the variable. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VariableName +The variable name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IVariable + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationWatcher.md b/swaggerci/automation/docs/Update-AzAutomationWatcher.md new file mode 100644 index 000000000000..937018bbd025 --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationWatcher.md @@ -0,0 +1,269 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationwatcher +schema: 2.0.0 +--- + +# Update-AzAutomationWatcher + +## SYNOPSIS +Update the watcher identified by watcher name. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationWatcher -AutomationAccountName -ResourceGroupName -WatcherName + [-SubscriptionId ] [-ExecutionFrequencyInSecond ] [-Name ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationWatcher -InputObject [-ExecutionFrequencyInSecond ] + [-Name ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update the watcher identified by watcher name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -ExecutionFrequencyInSecond +Gets or sets the frequency at which the watcher is invoked. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Gets or sets the name of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WatcherName +The watcher name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20200113Preview.IWatcher + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/docs/Update-AzAutomationWebhook.md b/swaggerci/automation/docs/Update-AzAutomationWebhook.md new file mode 100644 index 000000000000..75f0a4620062 --- /dev/null +++ b/swaggerci/automation/docs/Update-AzAutomationWebhook.md @@ -0,0 +1,315 @@ +--- +external help file: +Module Name: Az.Automation +online version: https://docs.microsoft.com/en-us/powershell/module/az.automation/update-azautomationwebhook +schema: 2.0.0 +--- + +# Update-AzAutomationWebhook + +## SYNOPSIS +Update the webhook identified by webhook name. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzAutomationWebhook -AutomationAccountName -ResourceGroupName -WebhookName + [-SubscriptionId ] [-Description ] [-IsEnabled] [-Name ] [-Parameter ] + [-RunOn ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzAutomationWebhook -InputObject [-Description ] [-IsEnabled] + [-Name ] [-Parameter ] [-RunOn ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update the webhook identified by webhook name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AutomationAccountName +The name of the automation account. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```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 +``` + +### -Description +Gets or sets the description of the webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +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.Automation.Models.IAutomationIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -IsEnabled +Gets or sets the value of the enabled flag of webhook. + +```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 +``` + +### -Name +Gets or sets the name of the webhook. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Gets or sets the parameters of the job. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +Name of an Azure Resource group. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RunOn +Gets or sets the name of the hybrid worker group the webhook job will run on. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +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. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebhookName +The webhook name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +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. + +```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.Automation.Models.IAutomationIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.Automation.Models.Api20151031.IWebhook + +## NOTES + +ALIASES + +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 + - `[ActivityName ]`: The name of activity. + - `[AutomationAccountName ]`: The name of the automation account. + - `[CertificateName ]`: The name of certificate. + - `[CompilationJobName ]`: The DSC configuration Id. + - `[ConfigurationName ]`: The configuration name. + - `[ConnectionName ]`: The name of connection. + - `[ConnectionTypeName ]`: The name of connection type. + - `[CountType ]`: The type of counts to retrieve + - `[CredentialName ]`: The name of credential. + - `[HybridRunbookWorkerGroupName ]`: The hybrid runbook worker group name + - `[HybridRunbookWorkerId ]`: The hybrid runbook worker id + - `[Id ]`: Resource identity path + - `[JobId ]`: The job id. + - `[JobName ]`: The name of the job to be created. + - `[JobScheduleId ]`: The job schedule name. + - `[JobStreamId ]`: The job stream id. + - `[ModuleName ]`: The name of module. + - `[NodeConfigurationName ]`: The Dsc node configuration name. + - `[NodeId ]`: The node id. + - `[PackageName ]`: The python package name. + - `[PrivateEndpointConnectionName ]`: The name of the private endpoint connection. + - `[ReportId ]`: The report id. + - `[ResourceGroupName ]`: Name of an Azure Resource group. + - `[RunbookName ]`: The runbook name. + - `[ScheduleName ]`: The schedule name. + - `[SoftwareUpdateConfigurationMachineRunId ]`: The Id of the software update configuration machine run. + - `[SoftwareUpdateConfigurationName ]`: The name of the software update configuration to be created. + - `[SoftwareUpdateConfigurationRunId ]`: The Id of the software update configuration run. + - `[SourceControlName ]`: The source control name. + - `[SourceControlSyncJobId ]`: The source control sync job id. + - `[StreamId ]`: The id of the sync job stream. + - `[SubscriptionId ]`: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. + - `[TypeName ]`: The name of type. + - `[VariableName ]`: The variable name. + - `[WatcherName ]`: The watcher name. + - `[WebhookName ]`: The webhook name. + +## RELATED LINKS + diff --git a/swaggerci/automation/examples/README.md b/swaggerci/automation/examples/README.md new file mode 100644 index 000000000000..a4c7754cdc40 --- /dev/null +++ b/swaggerci/automation/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/swaggerci/automation/how-to.md b/swaggerci/automation/how-to.md new file mode 100644 index 000000000000..b5cb327fc88e --- /dev/null +++ b/swaggerci/automation/how-to.md @@ -0,0 +1,58 @@ +# How-To +This document describes how to develop for `Az.Automation`. + +## Building `Az.Automation` +To build, run the `build-module.ps1` at the root of the module directory. This will generate the proxy script cmdlets that are the cmdlets being exported by this module. After the build completes, the proxy script cmdlets will be output to the `exports` folder. To read more about the proxy script cmdlets, look at the [README.md](exports/README.md) in the `exports` folder. + +## Creating custom cmdlets +To add cmdlets that were not generated by the REST specification, use the `custom` folder. This folder allows you to add handwritten `.ps1` and `.cs` files. Currently, we support using `.ps1` scripts as new cmdlets or as additional low-level variants (via `ParameterSet`), and `.cs` files as low-level (variants) cmdlets that the exported script cmdlets call. We do not support exporting any `.cs` (dll) cmdlets directly. To read more about custom cmdlets, look at the [README.md](custom/README.md) in the `custom` folder. + +## Generating documentation +To generate documentation, the process is now integrated into the `build-module.ps1` script. If you don't want to run this process as part of `build-module.ps1`, you can provide the `-NoDocs` switch. If you want to run documentation generation after the build process, you may still run the `generate-help.ps1` script. Overall, the process will look at the documentation comments in the generated and custom cmdlets and types, and create `.md` files into the `docs` folder. Additionally, this pulls in any examples from the `examples` folder and adds them to the generated help markdown documents. To read more about examples, look at the [README.md](examples/README.md) in the `examples` folder. To read more about documentation, look at the [README.md](docs/README.md) in the `docs` folder. + +## Testing `Az.Automation` +To test the cmdlets, we use [Pester](https://github.com/pester/Pester). Tests scripts (`.ps1`) should be added to the `test` folder. To execute the Pester tests, run the `test-module.ps1` script. This will run all tests in `playback` mode within the `test` folder. To read more about testing cmdlets, look at the [README.md](examples/README.md) in the `examples` folder. + +## Packing `Az.Automation` +To pack `Az.Automation` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://docs.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team. + +## Module Script Details +There are multiple scripts created for performing different actions for developing `Az.Automation`. +- `build-module.ps1` + - Builds the module DLL (`./bin/Az.Automation.private.dll`), creates the exported cmdlets and documentation, generates custom cmdlet test stubs and exported cmdlet example stubs, and updates `./Az.Automation.psd1` with Azure profile information. + - **Parameters**: [`Switch` parameters] + - `-Run`: After building, creates an isolated PowerShell session and loads `Az.Automation`. + - `-Test`: After building, runs the `Pester` tests defined in the `test` folder. + - `-Docs`: After building, generates the Markdown documents for the modules into the `docs` folder. + - `-Pack`: After building, packages the module into a `.nupkg`. + - `-Code`: After building, opens a VSCode window with the module's directory and runs (see `-Run`) the module. + - `-Release`: Builds the module in `Release` configuration (as opposed to `Debug` configuration). + - `-NoDocs`: Supresses writing the documentation markdown files as part of the cmdlet exporting process. + - `-Debugger`: Used when attaching the debugger in Visual Studio to the PowerShell session, and running the build process without recompiling the DLL. This suppresses running the script as an isolated process. +- `run-module.ps1` + - Creates an isolated PowerShell session and loads `Az.Automation` into the session. + - Same as `-Run` in `build-module.ps1`. + - **Parameters**: [`Switch` parameters] + - `-Code`: Opens a VSCode window with the module's directory. + - Same as `-Code` in `build-module.ps1`. +- `generate-help.ps1` + - Generates the Markdown documents for the modules into the `docs` folder. + - Same as `-Docs` in `build-module.ps1`. +- `test-module.ps1` + - Runs the `Pester` tests defined in the `test` folder. + - Same as `-Test` in `build-module.ps1`. +- `pack-module.ps1` + - Packages the module into a `.nupkg` for distribution. + - Same as `-Pack` in `build-module.ps1`. +- `generate-help.ps1` + - Generates the Markdown documents for the modules into the `docs` folder. + - Same as `-Docs` in `build-module.ps1`. + - This process is now integrated into `build-module.ps1` automatically. To disable, use `-NoDocs` when running `build-module.ps1`. +- `export-surface.ps1` + - Generates Markdown documents for both the cmdlet surface and the model (class) surface of the module. + - These files are placed into the `resources` folder. + - Used for investigating the surface of your module. These are *not* documentation for distribution. +- `check-dependencies.ps1` + - Used in `run-module.ps1` and `test-module.ps1` to verify dependent modules are available to run those tasks. + - It will download local (within the module's directory structure) versions of those modules as needed. + - This script *does not* need to be ran by-hand. \ No newline at end of file diff --git a/swaggerci/automation/license.txt b/swaggerci/automation/license.txt new file mode 100644 index 000000000000..b9f3180fb9af --- /dev/null +++ b/swaggerci/automation/license.txt @@ -0,0 +1,227 @@ +MICROSOFT SOFTWARE LICENSE TERMS + +MICROSOFT AZURE POWERSHELL + +These license terms are an agreement between Microsoft Corporation (or based on where you live, one of its affiliates) and you. Please read them. They apply to the software named above, which includes the media on which you received it, if any. + +BY USING THE SOFTWARE, YOU ACCEPT THESE TERMS. IF YOU DO NOT ACCEPT THEM, DO NOT USE THE SOFTWARE. + + +-----------------START OF LICENSE-------------------------- + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +-------------------END OF LICENSE------------------------------------------ + + +----------------START OF THIRD PARTY NOTICE-------------------------------- + + +The software includes the AutoMapper library ("AutoMapper"). The MIT License set out below is provided for informational purposes only. It is not the license that governs any part of the software. + +Provided for Informational Purposes Only + +AutoMapper + +The MIT License (MIT) +Copyright (c) 2010 Jimmy Bogard + + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + + + + + +*************** + +The software includes Newtonsoft.Json. The MIT License set out below is provided for informational purposes only. It is not the license that governs any part of the software. + +Newtonsoft.Json + +The MIT License (MIT) +Copyright (c) 2007 James Newton-King +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +-------------END OF THIRD PARTY NOTICE---------------------------------------- + diff --git a/swaggerci/automation/readme.md b/swaggerci/automation/readme.md new file mode 100644 index 000000000000..8ba62358d341 --- /dev/null +++ b/swaggerci/automation/readme.md @@ -0,0 +1,10 @@ +### AutoRest Configuration +> see https://aka.ms/autorest + +``` yaml +require: + - $(this-folder)/../../tools/SwaggerCI/readme.azure.noprofile.md + - $(this-folder)/../../../azure-rest-api-specs/specification/automation/resource-manager/readme.md +try-require: + - $(this-folder)/../../../azure-rest-api-specs/specification/automation/resource-manager/readme.powershell.md +``` diff --git a/swaggerci/automation/resources/README.md b/swaggerci/automation/resources/README.md new file mode 100644 index 000000000000..736492341e3d --- /dev/null +++ b/swaggerci/automation/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/swaggerci/automation/test/README.md b/swaggerci/automation/test/README.md new file mode 100644 index 000000000000..1969200c6a09 --- /dev/null +++ b/swaggerci/automation/test/README.md @@ -0,0 +1,17 @@ +# Test +This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `../custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: no + +## Details +We allow three testing modes: *live*, *record*, and *playback*. These can be selected using the `-Live`, `-Record`, and `-Playback` switches respectively on the `test-module.ps1` script. This script will run through any `.Tests.ps1` scripts in the `test` folder. If you choose the *record* mode, it will create a `.Recording.json` file of the REST calls between the client and server. Then, when you choose *playback* mode, it will use the `.Recording.json` file to mock the communication between server and client. The *live* mode runs the same as the *record* mode; however, it doesn't create the `.Recording.json` file. + +## Purpose +Custom cmdlets generally encompass additional functionality not described in the REST specification, or combines functionality generated from the REST spec. To validate this functionality continues to operate as intended, creating tests that can be ran and re-ran against custom cmdlets is part of the framework. + +## Usage +To execute tests, run the `test-module.ps1`. To write tests, [this example](https://github.com/pester/Pester/blob/8b9cf4248315e44f1ac6673be149f7e0d7f10466/Examples/Planets/Get-Planet.Tests.ps1#L1) from the Pester repository is very useful for getting started. \ No newline at end of file diff --git a/swaggerci/automation/test/loadEnv.ps1 b/swaggerci/automation/test/loadEnv.ps1 new file mode 100644 index 000000000000..0ea394729062 --- /dev/null +++ b/swaggerci/automation/test/loadEnv.ps1 @@ -0,0 +1,21 @@ +# ---------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# ---------------------------------------------------------------------------------- +$envFile = 'env.json' +if ($TestMode -eq 'live') { + $envFile = 'localEnv.json' +} + +if (Test-Path -Path (Join-Path $PSScriptRoot $envFile)) { + $envFilePath = Join-Path $PSScriptRoot $envFile +} else { + $envFilePath = Join-Path $PSScriptRoot '..\$envFile' +} +$env = @{} +if (Test-Path -Path $envFilePath) { + $env = Get-Content (Join-Path $PSScriptRoot $envFile) | ConvertFrom-Json + $PSDefaultParameterValues=@{"*:SubscriptionId"=$env.SubscriptionId; "*:Tenant"=$env.Tenant} +} \ No newline at end of file diff --git a/swaggerci/automation/test/utils.ps1 b/swaggerci/automation/test/utils.ps1 new file mode 100644 index 000000000000..1990edd45299 --- /dev/null +++ b/swaggerci/automation/test/utils.ps1 @@ -0,0 +1,31 @@ +function RandomString([bool]$allChars, [int32]$len) { + if ($allChars) { + return -join ((33..126) | Get-Random -Count $len | % {[char]$_}) + } else { + return -join ((48..57) + (97..122) | Get-Random -Count $len | % {[char]$_}) + } +} +$env = @{} +if ($UsePreviousConfigForRecord) { + $previousEnv = Get-Content (Join-Path $PSScriptRoot 'env.json') | ConvertFrom-Json + $previousEnv.psobject.properties | Foreach-Object { $env[$_.Name] = $_.Value } +} +# Add script method called AddWithCache to $env, when useCache is set true, it will try to get the value from the $env first. +# example: $val = $env.AddWithCache('key', $val, $true) +$env | Add-Member -Type ScriptMethod -Value { param( [string]$key, [object]$val, [bool]$useCache) if ($this.Contains($key) -and $useCache) { return $this[$key] } else { $this[$key] = $val; return $val } } -Name 'AddWithCache' +function setupEnv() { + # Preload subscriptionId and tenant from context, which will be used in test + # as default. You could change them if needed. + $env.SubscriptionId = (Get-AzContext).Subscription.Id + $env.Tenant = (Get-AzContext).Tenant.Id + # For any resources you created for test, you should add it to $env here. + $envFile = 'env.json' + if ($TestMode -eq 'live') { + $envFile = 'localEnv.json' + } + set-content -Path (Join-Path $PSScriptRoot $envFile) -Value (ConvertTo-Json $env) +} +function cleanupEnv() { + # Clean resources you create for testing +} + diff --git a/swaggerci/automation/utils/Unprotect-SecureString.ps1 b/swaggerci/automation/utils/Unprotect-SecureString.ps1 new file mode 100644 index 000000000000..cb05b51a6220 --- /dev/null +++ b/swaggerci/automation/utils/Unprotect-SecureString.ps1 @@ -0,0 +1,16 @@ +#This script converts securestring to plaintext + +param( + [Parameter(Mandatory, ValueFromPipeline)] + [System.Security.SecureString] + ${SecureString} +) + +$ssPtr = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($SecureString) +try { + $plaintext = [System.Runtime.InteropServices.Marshal]::PtrToStringBSTR($ssPtr) +} finally { + [System.Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ssPtr) +} + +return $plaintext \ No newline at end of file