diff --git a/.gitignore b/.gitignore index cf59ade8d3b2..2f286eae7a04 100644 --- a/.gitignore +++ b/.gitignore @@ -229,3 +229,4 @@ launchSettings.json /tools/Modules/tmp /tools/Az/Az.psm1 /Azure.PowerShell.sln +src/HybridConnectivity/HybridConnectivity.Autorest/test/localEnv.json diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/.gitattributes b/src/HybridConnectivity/HybridConnectivity.Autorest/.gitattributes new file mode 100644 index 000000000000..2125666142eb --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/.gitattributes @@ -0,0 +1 @@ +* text=auto \ No newline at end of file diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/.gitignore b/src/HybridConnectivity/HybridConnectivity.Autorest/.gitignore new file mode 100644 index 000000000000..ccbe8d018341 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/.gitignore @@ -0,0 +1,18 @@ +bin +obj +.vs +generated +internal +exports +tools +custom/*.psm1 +custom/autogen-model-cmdlets +test/*-TestResults.xml +license.txt +/*.ps1 +/*.psd1 +/*.ps1xml +/*.psm1 +/*.snk +/*.csproj +/*.nuspec \ No newline at end of file diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/README.md b/src/HybridConnectivity/HybridConnectivity.Autorest/README.md new file mode 100644 index 000000000000..bb680c91d97c --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/README.md @@ -0,0 +1,74 @@ + +# Az.HybridConnectivity +This directory contains the PowerShell module for the HybridConnectivity service. + +--- +## 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.HybridConnectivity`, see [how-to.md](how-to.md). + + +### AutoRest Configuration +> see https://aka.ms/autorest +```yaml +# pin the swagger version by using the commit id instead of branch name +commit: 9a8af2acfafc4d7a23eff41b859d2d332f51b0bc + +require: +# readme.azure.noprofile.md is the common configuration file + - $(this-folder)/../../readme.azure.noprofile.md + - $(repo)/specification/hybridconnectivity/resource-manager/readme.md + +# If the swagger has not been put in the repo, you may uncomment the following line and refer to it locally +# - (this-folder)/relative-path-to-your-local-readme.md + +try-require: + - $(repo)/specification/hybridconnectivity/resource-manager/readme.powershell.md + +# For new RP, the version is 0.1.0 +module-version: 0.1.0 +# Normally, title is the service name +title: HybridConnectivity +subject-prefix: HybridConnectivity + +# The next three configurations are exclusive to v3, and in v4, they are activated by default. If you are still using v3, please uncomment them. +# identity-correction-for-post: true +# resourcegroup-append: true +# nested-object-to-string: true + +directive: + # Following are common directives which are normally required in all the RPs + # 1. Remove the unexpanded parameter set + # 2. For New-* cmdlets, ViaIdentity is not required + # Following two directives are v4 specific + - where: + variant: ^(Create|Update)(?!.*?(Expanded|JsonFilePath|JsonString)) + remove: true + - where: + variant: ^CreateViaIdentity.*$ + remove: true + # Follow directive is v3 specific. If you are using v3, uncomment following directive and comments out two directives above + #- where: + # variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$ + # remove: true + + # Remove the set-* cmdlet + - where: + verb: Set + remove: true +``` diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/endpoints-serviceConfigurations.json b/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/endpoints-serviceConfigurations.json new file mode 100644 index 000000000000..794b31f830f2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/endpoints-serviceConfigurations.json @@ -0,0 +1,85 @@ +{ + "resourceType": "endpoints/serviceConfigurations", + "apiVersion": "2024-12-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity" + }, + "commands": [ + { + "name": "Get-AzHybridConnectivityServiceConfiguration", + "description": "Gets the details about the service to the resource.", + "path": "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/serviceConfigurations/{serviceConfigurationName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivityserviceconfiguration" + }, + "parameterSets": [ + { + "parameters": [ + "-EndpointName ", + "-Name ", + "-ResourceUri " + ] + } + ] + }, + "examples": [ + { + "description": "Gets the details about the service to the resource.", + "parameters": [ + { + "name": "-EndpointName", + "value": "[Path.endpointName]" + }, + { + "name": "-Name", + "value": "[Path.serviceConfigurationName]" + }, + { + "name": "-ResourceUri", + "value": "[Path.resourceUri]" + } + ] + } + ] + }, + { + "name": "Remove-AzHybridConnectivityServiceConfiguration", + "description": "Deletes the service details to the target resource.", + "path": "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/serviceConfigurations/{serviceConfigurationName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity/remove-azhybridconnectivityserviceconfiguration" + }, + "parameterSets": [ + { + "parameters": [ + "-EndpointName ", + "-Name ", + "-ResourceUri " + ] + } + ] + }, + "examples": [ + { + "description": "Deletes the service details to the target resource.", + "parameters": [ + { + "name": "-EndpointName", + "value": "[Path.endpointName]" + }, + { + "name": "-Name", + "value": "[Path.serviceConfigurationName]" + }, + { + "name": "-ResourceUri", + "value": "[Path.resourceUri]" + } + ] + } + ] + } + ] +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/endpoints.json b/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/endpoints.json new file mode 100644 index 000000000000..728598fdce31 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/endpoints.json @@ -0,0 +1,75 @@ +{ + "resourceType": "endpoints", + "apiVersion": "2024-12-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity" + }, + "commands": [ + { + "name": "Get-AzHybridConnectivityEndpoint", + "description": "Gets the endpoint to the resource.", + "path": "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivityendpoint" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceUri " + ] + } + ] + }, + "examples": [ + { + "description": "Gets the endpoint to the resource.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.endpointName]" + }, + { + "name": "-ResourceUri", + "value": "[Path.resourceUri]" + } + ] + } + ] + }, + { + "name": "Remove-AzHybridConnectivityEndpoint", + "description": "Deletes the endpoint access to the target resource.", + "path": "/{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity/remove-azhybridconnectivityendpoint" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceUri " + ] + } + ] + }, + "examples": [ + { + "description": "Deletes the endpoint access to the target resource.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.endpointName]" + }, + { + "name": "-ResourceUri", + "value": "[Path.resourceUri]" + } + ] + } + ] + } + ] +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/publicCloudConnectors.json b/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/publicCloudConnectors.json new file mode 100644 index 000000000000..60e05286fcdd --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/publicCloudConnectors.json @@ -0,0 +1,123 @@ +{ + "resourceType": "publicCloudConnectors", + "apiVersion": "2024-12-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity" + }, + "commands": [ + { + "name": "Get-AzHybridConnectivityPublicCloudConnector", + "description": "Get a PublicCloudConnector", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivitypubliccloudconnector" + }, + "parameterSets": [ + { + "parameters": [ + "-PublicCloudConnector ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get a PublicCloudConnector", + "parameters": [ + { + "name": "-PublicCloudConnector", + "value": "[Path.publicCloudConnector]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzHybridConnectivityPublicCloudConnector", + "description": "Delete a PublicCloudConnector", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity/remove-azhybridconnectivitypubliccloudconnector" + }, + "parameterSets": [ + { + "parameters": [ + "-PublicCloudConnector ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Delete a PublicCloudConnector", + "parameters": [ + { + "name": "-PublicCloudConnector", + "value": "[Path.publicCloudConnector]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Test-AzHybridConnectivityPublicCloudConnectorPermission", + "description": "A long-running resource action.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}/testPermissions", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity/test-azhybridconnectivitypubliccloudconnectorpermission" + }, + "parameterSets": [ + { + "parameters": [ + "-PublicCloudConnector ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "A long-running resource action.", + "parameters": [ + { + "name": "-PublicCloudConnector", + "value": "[Path.publicCloudConnector]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/solutionConfigurations-inventory.json b/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/solutionConfigurations-inventory.json new file mode 100644 index 000000000000..cdd4a1a264c0 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/solutionConfigurations-inventory.json @@ -0,0 +1,47 @@ +{ + "resourceType": "solutionConfigurations/inventory", + "apiVersion": "2024-12-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity" + }, + "commands": [ + { + "name": "Get-AzHybridConnectivityInventory", + "description": "Get a InventoryResource", + "path": "/{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}/inventory/{inventoryId}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivityinventory" + }, + "parameterSets": [ + { + "parameters": [ + "-Id ", + "-ResourceUri ", + "-SolutionConfiguration " + ] + } + ] + }, + "examples": [ + { + "description": "Get a InventoryResource", + "parameters": [ + { + "name": "-Id", + "value": "[Path.inventoryId]" + }, + { + "name": "-ResourceUri", + "value": "[Path.resourceUri]" + }, + { + "name": "-SolutionConfiguration", + "value": "[Path.solutionConfiguration]" + } + ] + } + ] + } + ] +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/solutionConfigurations.json b/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/solutionConfigurations.json new file mode 100644 index 000000000000..dddaea81599f --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/solutionConfigurations.json @@ -0,0 +1,108 @@ +{ + "resourceType": "solutionConfigurations", + "apiVersion": "2024-12-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity" + }, + "commands": [ + { + "name": "Get-AzHybridConnectivitySolutionConfiguration", + "description": "Get a SolutionConfiguration", + "path": "/{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivitysolutionconfiguration" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceUri ", + "-SolutionConfiguration " + ] + } + ] + }, + "examples": [ + { + "description": "Get a SolutionConfiguration", + "parameters": [ + { + "name": "-ResourceUri", + "value": "[Path.resourceUri]" + }, + { + "name": "-SolutionConfiguration", + "value": "[Path.solutionConfiguration]" + } + ] + } + ] + }, + { + "name": "Remove-AzHybridConnectivitySolutionConfiguration", + "description": "Delete a SolutionConfiguration", + "path": "/{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity/remove-azhybridconnectivitysolutionconfiguration" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceUri ", + "-SolutionConfiguration " + ] + } + ] + }, + "examples": [ + { + "description": "Delete a SolutionConfiguration", + "parameters": [ + { + "name": "-ResourceUri", + "value": "[Path.resourceUri]" + }, + { + "name": "-SolutionConfiguration", + "value": "[Path.solutionConfiguration]" + } + ] + } + ] + }, + { + "name": "Sync-AzHybridConnectivitySolutionConfigurationNow", + "description": "Trigger immediate sync with source cloud", + "path": "/{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}/syncNow", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity/sync-azhybridconnectivitysolutionconfigurationnow" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceUri ", + "-SolutionConfiguration " + ] + } + ] + }, + "examples": [ + { + "description": "Trigger immediate sync with source cloud", + "parameters": [ + { + "name": "-ResourceUri", + "value": "[Path.resourceUri]" + }, + { + "name": "-SolutionConfiguration", + "value": "[Path.solutionConfiguration]" + } + ] + } + ] + } + ] +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/solutionTypes.json b/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/solutionTypes.json new file mode 100644 index 000000000000..5d9caccf3f91 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/UX/Microsoft.HybridConnectivity/solutionTypes.json @@ -0,0 +1,47 @@ +{ + "resourceType": "solutionTypes", + "apiVersion": "2024-12-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity" + }, + "commands": [ + { + "name": "Get-AzHybridConnectivitySolutionType", + "description": "Get a SolutionTypeResource", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/solutionTypes/{solutionType}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivitysolutiontype" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceGroupName ", + "-SolutionType ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Get a SolutionTypeResource", + "parameters": [ + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SolutionType", + "value": "[Path.solutionType]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/custom/README.md b/src/HybridConnectivity/HybridConnectivity.Autorest/custom/README.md new file mode 100644 index 000000000000..9dc2388ad678 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/custom/README.md @@ -0,0 +1,41 @@ +# Custom +This directory contains custom implementation for non-generated cmdlets for the `Az.HybridConnectivity` 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.HybridConnectivity.custom.psm1`. This file should not be modified. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: yes + +## Details +For `Az.HybridConnectivity` 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.HybridConnectivity.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.HybridConnectivity.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.HybridConnectivity`. 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.HybridConnectivity.DescriptionAttribute` + - Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts. +- `Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.DoNotExportAttribute` + - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.HybridConnectivity`. +- `Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.InternalExportAttribute` + - Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.HybridConnectivity`. For more information, see [README.md](../internal/README.md) in the `../internal` folder. +- `Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.ProfileAttribute` + - Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules. \ No newline at end of file diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Az.HybridConnectivity.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Az.HybridConnectivity.md new file mode 100644 index 000000000000..d8eb5f194901 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Az.HybridConnectivity.md @@ -0,0 +1,85 @@ +--- +Module Name: Az.HybridConnectivity +Module Guid: 18287593-27f5-4865-8204-4eaeb281168d +Download Help Link: https://learn.microsoft.com/powershell/module/az.hybridconnectivity +Help Version: 1.0.0.0 +Locale: en-US +--- + +# Az.HybridConnectivity Module +## Description +Microsoft Azure PowerShell: HybridConnectivity cmdlets + +## Az.HybridConnectivity Cmdlets +### [Get-AzHybridConnectivityEndpoint](Get-AzHybridConnectivityEndpoint.md) +Gets the endpoint to the resource. + +### [Get-AzHybridConnectivityEndpointCredentials](Get-AzHybridConnectivityEndpointCredentials.md) +Gets the endpoint access credentials to the resource. + +### [Get-AzHybridConnectivityEndpointIngressGatewayCredentials](Get-AzHybridConnectivityEndpointIngressGatewayCredentials.md) +Gets the ingress gateway endpoint credentials + +### [Get-AzHybridConnectivityEndpointManagedProxyDetail](Get-AzHybridConnectivityEndpointManagedProxyDetail.md) +Fetches the managed proxy details + +### [Get-AzHybridConnectivityInventory](Get-AzHybridConnectivityInventory.md) +Get a InventoryResource + +### [Get-AzHybridConnectivityPublicCloudConnector](Get-AzHybridConnectivityPublicCloudConnector.md) +Get a PublicCloudConnector + +### [Get-AzHybridConnectivityServiceConfiguration](Get-AzHybridConnectivityServiceConfiguration.md) +Gets the details about the service to the resource. + +### [Get-AzHybridConnectivitySolutionConfiguration](Get-AzHybridConnectivitySolutionConfiguration.md) +Get a SolutionConfiguration + +### [Get-AzHybridConnectivitySolutionType](Get-AzHybridConnectivitySolutionType.md) +Get a SolutionTypeResource + +### [Invoke-AzHybridConnectivityGenerateAwsTemplate](Invoke-AzHybridConnectivityGenerateAwsTemplate.md) +Retrieve AWS Cloud Formation template + +### [New-AzHybridConnectivityEndpoint](New-AzHybridConnectivityEndpoint.md) +create the endpoint to the target resource. + +### [New-AzHybridConnectivityPublicCloudConnector](New-AzHybridConnectivityPublicCloudConnector.md) +create a PublicCloudConnector + +### [New-AzHybridConnectivityServiceConfigurationOrupdate](New-AzHybridConnectivityServiceConfigurationOrupdate.md) +create a service in serviceConfiguration for the endpoint resource. + +### [New-AzHybridConnectivitySolutionConfiguration](New-AzHybridConnectivitySolutionConfiguration.md) +create a SolutionConfiguration + +### [Remove-AzHybridConnectivityEndpoint](Remove-AzHybridConnectivityEndpoint.md) +Deletes the endpoint access to the target resource. + +### [Remove-AzHybridConnectivityPublicCloudConnector](Remove-AzHybridConnectivityPublicCloudConnector.md) +Delete a PublicCloudConnector + +### [Remove-AzHybridConnectivityServiceConfiguration](Remove-AzHybridConnectivityServiceConfiguration.md) +Deletes the service details to the target resource. + +### [Remove-AzHybridConnectivitySolutionConfiguration](Remove-AzHybridConnectivitySolutionConfiguration.md) +Delete a SolutionConfiguration + +### [Sync-AzHybridConnectivitySolutionConfigurationNow](Sync-AzHybridConnectivitySolutionConfigurationNow.md) +Trigger immediate sync with source cloud + +### [Test-AzHybridConnectivityPublicCloudConnectorPermission](Test-AzHybridConnectivityPublicCloudConnectorPermission.md) +A long-running resource action. + +### [Update-AzHybridConnectivityEndpoint](Update-AzHybridConnectivityEndpoint.md) +update the endpoint to the target resource. + +### [Update-AzHybridConnectivityPublicCloudConnector](Update-AzHybridConnectivityPublicCloudConnector.md) +update a PublicCloudConnector + +### [Update-AzHybridConnectivityServiceConfiguration](Update-AzHybridConnectivityServiceConfiguration.md) +update the service details in the service configurations of the target resource. + +### [Update-AzHybridConnectivitySolutionConfiguration](Update-AzHybridConnectivitySolutionConfiguration.md) +update a SolutionConfiguration + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityEndpoint.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityEndpoint.md new file mode 100644 index 000000000000..5d9179860eda --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityEndpoint.md @@ -0,0 +1,136 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivityendpoint +schema: 2.0.0 +--- + +# Get-AzHybridConnectivityEndpoint + +## SYNOPSIS +Gets the endpoint to the resource. + +## SYNTAX + +### List (Default) +``` +Get-AzHybridConnectivityEndpoint -ResourceUri [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzHybridConnectivityEndpoint -Name -ResourceUri [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzHybridConnectivityEndpoint -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets the endpoint to the resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The endpoint name. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +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 + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IEndpointResource + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityEndpointCredentials.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityEndpointCredentials.md new file mode 100644 index 000000000000..4b688a7e3650 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityEndpointCredentials.md @@ -0,0 +1,237 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivityendpointcredentials +schema: 2.0.0 +--- + +# Get-AzHybridConnectivityEndpointCredentials + +## SYNOPSIS +Gets the endpoint access credentials to the resource. + +## SYNTAX + +### ListExpanded (Default) +``` +Get-AzHybridConnectivityEndpointCredentials -EndpointName -ResourceUri [-Expiresin ] + [-ServiceName ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### List +``` +Get-AzHybridConnectivityEndpointCredentials -EndpointName -ResourceUri + -ListCredentialsRequest [-Expiresin ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### ListViaJsonFilePath +``` +Get-AzHybridConnectivityEndpointCredentials -EndpointName -ResourceUri + -JsonFilePath [-Expiresin ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### ListViaJsonString +``` +Get-AzHybridConnectivityEndpointCredentials -EndpointName -ResourceUri -JsonString + [-Expiresin ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Gets the endpoint access credentials to the resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +The endpoint name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expiresin +The is how long the endpoint access token is valid (in seconds). + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListCredentialsRequest +The details of the service for which credentials needs to be returned. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IListCredentialsRequest +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the service. +If not provided, the request will by pass the generation of service configuration token + +```yaml +Type: System.String +Parameter Sets: ListExpanded +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.HybridConnectivity.Models.IListCredentialsRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IEndpointAccessResource + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityEndpointIngressGatewayCredentials.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityEndpointIngressGatewayCredentials.md new file mode 100644 index 000000000000..027df59456bf --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityEndpointIngressGatewayCredentials.md @@ -0,0 +1,238 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivityendpointingressgatewaycredentials +schema: 2.0.0 +--- + +# Get-AzHybridConnectivityEndpointIngressGatewayCredentials + +## SYNOPSIS +Gets the ingress gateway endpoint credentials + +## SYNTAX + +### ListExpanded (Default) +``` +Get-AzHybridConnectivityEndpointIngressGatewayCredentials -EndpointName -ResourceUri + [-Expiresin ] [-ServiceName ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### List +``` +Get-AzHybridConnectivityEndpointIngressGatewayCredentials -EndpointName -ResourceUri + -ListIngressGatewayCredentialsRequest [-Expiresin ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### ListViaJsonFilePath +``` +Get-AzHybridConnectivityEndpointIngressGatewayCredentials -EndpointName -ResourceUri + -JsonFilePath [-Expiresin ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### ListViaJsonString +``` +Get-AzHybridConnectivityEndpointIngressGatewayCredentials -EndpointName -ResourceUri + -JsonString [-Expiresin ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Gets the ingress gateway endpoint credentials + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +The endpoint name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expiresin +The is how long the endpoint access token is valid (in seconds). + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListIngressGatewayCredentialsRequest +Represent ListIngressGatewayCredentials Request object. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IListIngressGatewayCredentialsRequest +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the service. + +```yaml +Type: System.String +Parameter Sets: ListExpanded +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.HybridConnectivity.Models.IListIngressGatewayCredentialsRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IIngressGatewayResource + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityEndpointManagedProxyDetail.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityEndpointManagedProxyDetail.md new file mode 100644 index 000000000000..aed1eb9003a0 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityEndpointManagedProxyDetail.md @@ -0,0 +1,252 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivityendpointmanagedproxydetail +schema: 2.0.0 +--- + +# Get-AzHybridConnectivityEndpointManagedProxyDetail + +## SYNOPSIS +Fetches the managed proxy details + +## SYNTAX + +### ListExpanded (Default) +``` +Get-AzHybridConnectivityEndpointManagedProxyDetail -EndpointName -ResourceUri + -Service [-Hostname ] [-ServiceName ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### List +``` +Get-AzHybridConnectivityEndpointManagedProxyDetail -EndpointName -ResourceUri + -ManagedProxyRequest [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### ListViaJsonFilePath +``` +Get-AzHybridConnectivityEndpointManagedProxyDetail -EndpointName -ResourceUri + -JsonFilePath [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### ListViaJsonString +``` +Get-AzHybridConnectivityEndpointManagedProxyDetail -EndpointName -ResourceUri + -JsonString [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Fetches the managed proxy details + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +The endpoint name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Hostname +The target host name. + +```yaml +Type: System.String +Parameter Sets: ListExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedProxyRequest +Represent ManageProxy Request object. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IManagedProxyRequest +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Service +The name of the service. + +```yaml +Type: System.String +Parameter Sets: ListExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The name of the service. +It is an optional property, if not provided, service configuration tokens issue code would be by passed. + +```yaml +Type: System.String +Parameter Sets: ListExpanded +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.HybridConnectivity.Models.IManagedProxyRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IManagedProxyResource + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityInventory.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityInventory.md new file mode 100644 index 000000000000..00bc85715c67 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityInventory.md @@ -0,0 +1,173 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivityinventory +schema: 2.0.0 +--- + +# Get-AzHybridConnectivityInventory + +## SYNOPSIS +Get a InventoryResource + +## SYNTAX + +### List (Default) +``` +Get-AzHybridConnectivityInventory -ResourceUri -SolutionConfiguration + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzHybridConnectivityInventory -Id -ResourceUri -SolutionConfiguration + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzHybridConnectivityInventory -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentitySolutionConfiguration +``` +Get-AzHybridConnectivityInventory -Id -SolutionConfigurationInputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a InventoryResource + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Id +Inventory resource + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentitySolutionConfiguration +Aliases: InventoryId + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionConfiguration +Represent Solution Configuration Resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionConfigurationInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: GetViaIdentitySolutionConfiguration +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IInventoryResource + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityPublicCloudConnector.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityPublicCloudConnector.md new file mode 100644 index 000000000000..40c9d8a5ea1f --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityPublicCloudConnector.md @@ -0,0 +1,160 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivitypubliccloudconnector +schema: 2.0.0 +--- + +# Get-AzHybridConnectivityPublicCloudConnector + +## SYNOPSIS +Get a PublicCloudConnector + +## SYNTAX + +### List (Default) +``` +Get-AzHybridConnectivityPublicCloudConnector [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzHybridConnectivityPublicCloudConnector -PublicCloudConnector -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzHybridConnectivityPublicCloudConnector -InputObject + [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzHybridConnectivityPublicCloudConnector -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a PublicCloudConnector + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PublicCloudConnector +Represent public cloud connectors resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, 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.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IPublicCloudConnector + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityServiceConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityServiceConfiguration.md new file mode 100644 index 000000000000..0b1eaee65980 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivityServiceConfiguration.md @@ -0,0 +1,173 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivityserviceconfiguration +schema: 2.0.0 +--- + +# Get-AzHybridConnectivityServiceConfiguration + +## SYNOPSIS +Gets the details about the service to the resource. + +## SYNTAX + +### List (Default) +``` +Get-AzHybridConnectivityServiceConfiguration -EndpointName -ResourceUri + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzHybridConnectivityServiceConfiguration -EndpointName -Name -ResourceUri + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzHybridConnectivityServiceConfiguration -InputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityEndpoint +``` +Get-AzHybridConnectivityServiceConfiguration -EndpointInputObject -Name + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the details about the service to the resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: GetViaIdentityEndpoint +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -EndpointName +The endpoint 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 +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The service name. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityEndpoint +Aliases: ServiceConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Get, List +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 + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IServiceConfigurationResource + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivitySolutionConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivitySolutionConfiguration.md new file mode 100644 index 000000000000..30f86785a0b4 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivitySolutionConfiguration.md @@ -0,0 +1,137 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivitysolutionconfiguration +schema: 2.0.0 +--- + +# Get-AzHybridConnectivitySolutionConfiguration + +## SYNOPSIS +Get a SolutionConfiguration + +## SYNTAX + +### List (Default) +``` +Get-AzHybridConnectivitySolutionConfiguration -ResourceUri [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzHybridConnectivitySolutionConfiguration -ResourceUri -SolutionConfiguration + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzHybridConnectivitySolutionConfiguration -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a SolutionConfiguration + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionConfiguration +Represent Solution Configuration Resource. + +```yaml +Type: System.String +Parameter Sets: Get +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 + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.ISolutionConfiguration + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivitySolutionType.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivitySolutionType.md new file mode 100644 index 000000000000..172e61b9e679 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Get-AzHybridConnectivitySolutionType.md @@ -0,0 +1,160 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/get-azhybridconnectivitysolutiontype +schema: 2.0.0 +--- + +# Get-AzHybridConnectivitySolutionType + +## SYNOPSIS +Get a SolutionTypeResource + +## SYNTAX + +### List (Default) +``` +Get-AzHybridConnectivitySolutionType [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzHybridConnectivitySolutionType -ResourceGroupName -SolutionType + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzHybridConnectivitySolutionType -InputObject [-DefaultProfile ] + [] +``` + +### List1 +``` +Get-AzHybridConnectivitySolutionType -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get a SolutionTypeResource + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionType +Solution Type resource + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, 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.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.ISolutionTypeResource + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Invoke-AzHybridConnectivityGenerateAwsTemplate.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Invoke-AzHybridConnectivityGenerateAwsTemplate.md new file mode 100644 index 000000000000..74a7bbb12ab1 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Invoke-AzHybridConnectivityGenerateAwsTemplate.md @@ -0,0 +1,221 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/invoke-azhybridconnectivitygenerateawstemplate +schema: 2.0.0 +--- + +# Invoke-AzHybridConnectivityGenerateAwsTemplate + +## SYNOPSIS +Retrieve AWS Cloud Formation template + +## SYNTAX + +### PostExpanded (Default) +``` +Invoke-AzHybridConnectivityGenerateAwsTemplate -ConnectorId [-SubscriptionId ] + [-SolutionType ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### Post +``` +Invoke-AzHybridConnectivityGenerateAwsTemplate -GenerateAwsTemplateRequest + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### PostViaJsonFilePath +``` +Invoke-AzHybridConnectivityGenerateAwsTemplate -JsonFilePath [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### PostViaJsonString +``` +Invoke-AzHybridConnectivityGenerateAwsTemplate -JsonString [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Retrieve AWS Cloud Formation template + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -ConnectorId +The name of public cloud connector + +```yaml +Type: System.String +Parameter Sets: PostExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GenerateAwsTemplateRequest +ConnectorId and SolutionTypes and their properties to Generate AWS CFT Template. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IGenerateAwsTemplateRequest +Parameter Sets: Post +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Post operation + +```yaml +Type: System.String +Parameter Sets: PostViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Post operation + +```yaml +Type: System.String +Parameter Sets: PostViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionType +The list of solution types and their settings + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.ISolutionTypeSettings[] +Parameter Sets: PostExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IGenerateAwsTemplateRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IAny + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/New-AzHybridConnectivityEndpoint.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/New-AzHybridConnectivityEndpoint.md new file mode 100644 index 000000000000..8af7176da9a7 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/New-AzHybridConnectivityEndpoint.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/new-azhybridconnectivityendpoint +schema: 2.0.0 +--- + +# New-AzHybridConnectivityEndpoint + +## SYNOPSIS +create the endpoint to the target resource. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzHybridConnectivityEndpoint -Name -ResourceUri [-PropertiesType ] + [-ResourceId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzHybridConnectivityEndpoint -Name -ResourceUri -JsonFilePath + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzHybridConnectivityEndpoint -Name -ResourceUri -JsonString + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +create the endpoint to the target resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The endpoint name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertiesType +The type of endpoint. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id of the connectivity endpoint (optional). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```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.HybridConnectivity.Models.IEndpointResource + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/New-AzHybridConnectivityPublicCloudConnector.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/New-AzHybridConnectivityPublicCloudConnector.md new file mode 100644 index 000000000000..0840f246d6b6 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/New-AzHybridConnectivityPublicCloudConnector.md @@ -0,0 +1,308 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/new-azhybridconnectivitypubliccloudconnector +schema: 2.0.0 +--- + +# New-AzHybridConnectivityPublicCloudConnector + +## SYNOPSIS +create a PublicCloudConnector + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzHybridConnectivityPublicCloudConnector -PublicCloudConnector -ResourceGroupName + -Location [-SubscriptionId ] [-AwCloudProfileAccountId ] + [-AwCloudProfileExcludedAccount ] [-AwCloudProfileIsOrganizationalAccount] [-Tag ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzHybridConnectivityPublicCloudConnector -PublicCloudConnector -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzHybridConnectivityPublicCloudConnector -PublicCloudConnector -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +create a PublicCloudConnector + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AwCloudProfileAccountId +Account id for the AWS account. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AwCloudProfileExcludedAccount +List of AWS accounts which need to be excluded. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AwCloudProfileIsOrganizationalAccount +Boolean value that indicates whether the account is organizational or not. +True represents organization account, whereas false represents a single account. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +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 +``` + +### -PublicCloudConnector +Represent public cloud connectors resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +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.HybridConnectivity.Models.IPublicCloudConnector + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/New-AzHybridConnectivityServiceConfigurationOrupdate.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/New-AzHybridConnectivityServiceConfigurationOrupdate.md new file mode 100644 index 000000000000..98e78c0b2605 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/New-AzHybridConnectivityServiceConfigurationOrupdate.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/new-azhybridconnectivityserviceconfigurationorupdate +schema: 2.0.0 +--- + +# New-AzHybridConnectivityServiceConfigurationOrupdate + +## SYNOPSIS +create a service in serviceConfiguration for the endpoint resource. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzHybridConnectivityServiceConfigurationOrupdate -EndpointName -ResourceUri + -ServiceConfigurationName [-Port ] [-ResourceId ] [-ServiceName ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzHybridConnectivityServiceConfigurationOrupdate -EndpointName -ResourceUri + -ServiceConfigurationName -JsonFilePath [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzHybridConnectivityServiceConfigurationOrupdate -EndpointName -ResourceUri + -ServiceConfigurationName -JsonString [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +create a service in serviceConfiguration for the endpoint resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointName +The endpoint name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +The port on which service is enabled. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id of the connectivity endpoint (optional). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceConfigurationName +The service name. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +Name of the service. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +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.HybridConnectivity.Models.IServiceConfigurationResource + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/New-AzHybridConnectivitySolutionConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/New-AzHybridConnectivitySolutionConfiguration.md new file mode 100644 index 000000000000..0311b049b8b3 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/New-AzHybridConnectivitySolutionConfiguration.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/new-azhybridconnectivitysolutionconfiguration +schema: 2.0.0 +--- + +# New-AzHybridConnectivitySolutionConfiguration + +## SYNOPSIS +create a SolutionConfiguration + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzHybridConnectivitySolutionConfiguration -ResourceUri -SolutionConfiguration + [-SolutionSetting ] [-SolutionType ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzHybridConnectivitySolutionConfiguration -ResourceUri -SolutionConfiguration + -JsonFilePath [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzHybridConnectivitySolutionConfiguration -ResourceUri -SolutionConfiguration + -JsonString [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +create a SolutionConfiguration + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionConfiguration +Represent Solution Configuration Resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionSetting +Solution settings + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionType +The type of the solution + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +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.HybridConnectivity.Models.ISolutionConfiguration + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/README.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/README.md new file mode 100644 index 000000000000..3c32f66e63ec --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/README.md @@ -0,0 +1,11 @@ +# Docs +This directory contains the documentation of the cmdlets for the `Az.HybridConnectivity` 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.HybridConnectivity` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder. \ No newline at end of file diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Remove-AzHybridConnectivityEndpoint.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Remove-AzHybridConnectivityEndpoint.md new file mode 100644 index 000000000000..c14fbb8f637a --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Remove-AzHybridConnectivityEndpoint.md @@ -0,0 +1,177 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/remove-azhybridconnectivityendpoint +schema: 2.0.0 +--- + +# Remove-AzHybridConnectivityEndpoint + +## SYNOPSIS +Deletes the endpoint access to the target resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzHybridConnectivityEndpoint -Name -ResourceUri [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzHybridConnectivityEndpoint -InputObject [-DefaultProfile ] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes the endpoint access to the target resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The endpoint name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: EndpointName + +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 +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +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.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Remove-AzHybridConnectivityPublicCloudConnector.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Remove-AzHybridConnectivityPublicCloudConnector.md new file mode 100644 index 000000000000..37e5ff3ab9b8 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Remove-AzHybridConnectivityPublicCloudConnector.md @@ -0,0 +1,194 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/remove-azhybridconnectivitypubliccloudconnector +schema: 2.0.0 +--- + +# Remove-AzHybridConnectivityPublicCloudConnector + +## SYNOPSIS +Delete a PublicCloudConnector + +## SYNTAX + +### Delete (Default) +``` +Remove-AzHybridConnectivityPublicCloudConnector -PublicCloudConnector -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzHybridConnectivityPublicCloudConnector -InputObject + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a PublicCloudConnector + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +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 +``` + +### -PublicCloudConnector +Represent public cloud connectors resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Remove-AzHybridConnectivityServiceConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Remove-AzHybridConnectivityServiceConfiguration.md new file mode 100644 index 000000000000..c78b53abc639 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Remove-AzHybridConnectivityServiceConfiguration.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/remove-azhybridconnectivityserviceconfiguration +schema: 2.0.0 +--- + +# Remove-AzHybridConnectivityServiceConfiguration + +## SYNOPSIS +Deletes the service details to the target resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzHybridConnectivityServiceConfiguration -EndpointName -Name -ResourceUri + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzHybridConnectivityServiceConfiguration -InputObject + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityEndpoint +``` +Remove-AzHybridConnectivityServiceConfiguration -EndpointInputObject + -Name [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes the service details to the target resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: DeleteViaIdentityEndpoint +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -EndpointName +The endpoint name. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The service name. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityEndpoint +Aliases: ServiceConfigurationName + +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 +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: Delete +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.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Remove-AzHybridConnectivitySolutionConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Remove-AzHybridConnectivitySolutionConfiguration.md new file mode 100644 index 000000000000..1455f24ad775 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Remove-AzHybridConnectivitySolutionConfiguration.md @@ -0,0 +1,177 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/remove-azhybridconnectivitysolutionconfiguration +schema: 2.0.0 +--- + +# Remove-AzHybridConnectivitySolutionConfiguration + +## SYNOPSIS +Delete a SolutionConfiguration + +## SYNTAX + +### Delete (Default) +``` +Remove-AzHybridConnectivitySolutionConfiguration -ResourceUri -SolutionConfiguration + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzHybridConnectivitySolutionConfiguration -InputObject + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Delete a SolutionConfiguration + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +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 +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionConfiguration +Represent Solution Configuration Resource. + +```yaml +Type: System.String +Parameter Sets: Delete +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.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Sync-AzHybridConnectivitySolutionConfigurationNow.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Sync-AzHybridConnectivitySolutionConfigurationNow.md new file mode 100644 index 000000000000..c3bed9295e79 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Sync-AzHybridConnectivitySolutionConfigurationNow.md @@ -0,0 +1,192 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/sync-azhybridconnectivitysolutionconfigurationnow +schema: 2.0.0 +--- + +# Sync-AzHybridConnectivitySolutionConfigurationNow + +## SYNOPSIS +Trigger immediate sync with source cloud + +## SYNTAX + +### Sync (Default) +``` +Sync-AzHybridConnectivitySolutionConfigurationNow -ResourceUri -SolutionConfiguration + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### SyncViaIdentity +``` +Sync-AzHybridConnectivitySolutionConfigurationNow -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Trigger immediate sync with source cloud + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: SyncViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource. + +```yaml +Type: System.String +Parameter Sets: Sync +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionConfiguration +Represent Solution Configuration Resource. + +```yaml +Type: System.String +Parameter Sets: Sync +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.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IOperationStatusResult + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Test-AzHybridConnectivityPublicCloudConnectorPermission.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Test-AzHybridConnectivityPublicCloudConnectorPermission.md new file mode 100644 index 000000000000..c54b154007ad --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Test-AzHybridConnectivityPublicCloudConnectorPermission.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/test-azhybridconnectivitypubliccloudconnectorpermission +schema: 2.0.0 +--- + +# Test-AzHybridConnectivityPublicCloudConnectorPermission + +## SYNOPSIS +A long-running resource action. + +## SYNTAX + +### Test (Default) +``` +Test-AzHybridConnectivityPublicCloudConnectorPermission -PublicCloudConnector + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### TestViaIdentity +``` +Test-AzHybridConnectivityPublicCloudConnectorPermission -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +A long-running resource action. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: TestViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +``` + +### -PublicCloudConnector +Represent public cloud connectors resource. + +```yaml +Type: System.String +Parameter Sets: Test +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Test +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Test +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.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IOperationStatusResult + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Update-AzHybridConnectivityEndpoint.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Update-AzHybridConnectivityEndpoint.md new file mode 100644 index 000000000000..bc4e31c56b1e --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Update-AzHybridConnectivityEndpoint.md @@ -0,0 +1,234 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/update-azhybridconnectivityendpoint +schema: 2.0.0 +--- + +# Update-AzHybridConnectivityEndpoint + +## SYNOPSIS +update the endpoint to the target resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzHybridConnectivityEndpoint -Name -ResourceUri [-PropertiesType ] + [-ResourceId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzHybridConnectivityEndpoint -InputObject [-PropertiesType ] + [-ResourceId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzHybridConnectivityEndpoint -Name -ResourceUri -JsonFilePath + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzHybridConnectivityEndpoint -Name -ResourceUri -JsonString + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +update the endpoint to the target resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The endpoint name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertiesType +The type of endpoint. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceId +The resource Id of the connectivity endpoint (optional). + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +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.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IEndpointResource + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Update-AzHybridConnectivityPublicCloudConnector.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Update-AzHybridConnectivityPublicCloudConnector.md new file mode 100644 index 000000000000..0610afa31eb8 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Update-AzHybridConnectivityPublicCloudConnector.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/update-azhybridconnectivitypubliccloudconnector +schema: 2.0.0 +--- + +# Update-AzHybridConnectivityPublicCloudConnector + +## SYNOPSIS +update a PublicCloudConnector + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzHybridConnectivityPublicCloudConnector -PublicCloudConnector -ResourceGroupName + [-SubscriptionId ] [-AwCloudProfileExcludedAccount ] [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzHybridConnectivityPublicCloudConnector -InputObject + [-AwCloudProfileExcludedAccount ] [-Tag ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzHybridConnectivityPublicCloudConnector -PublicCloudConnector -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonString +``` +Update-AzHybridConnectivityPublicCloudConnector -PublicCloudConnector -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +update a PublicCloudConnector + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AwCloudProfileExcludedAccount +List of AWS accounts which need to be excluded. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicCloudConnector +Represent public cloud connectors resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +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: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```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.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IPublicCloudConnector + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Update-AzHybridConnectivityServiceConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Update-AzHybridConnectivityServiceConfiguration.md new file mode 100644 index 000000000000..d40ef5fc6faf --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Update-AzHybridConnectivityServiceConfiguration.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/update-azhybridconnectivityserviceconfiguration +schema: 2.0.0 +--- + +# Update-AzHybridConnectivityServiceConfiguration + +## SYNOPSIS +update the service details in the service configurations of the target resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzHybridConnectivityServiceConfiguration -EndpointName -Name -ResourceUri + [-Port ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityEndpointExpanded +``` +Update-AzHybridConnectivityServiceConfiguration -EndpointInputObject + -Name [-Port ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzHybridConnectivityServiceConfiguration -InputObject [-Port ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzHybridConnectivityServiceConfiguration -EndpointName -Name -ResourceUri + -JsonFilePath [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzHybridConnectivityServiceConfiguration -EndpointName -Name -ResourceUri + -JsonString [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +update the service details in the service configurations of the target resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: UpdateViaIdentityEndpointExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -EndpointName +The endpoint name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The service name. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityEndpointExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: ServiceConfigurationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +The port on which service is enabled. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityEndpointExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource to be connected. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +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.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IServiceConfigurationResource + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Update-AzHybridConnectivitySolutionConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Update-AzHybridConnectivitySolutionConfiguration.md new file mode 100644 index 000000000000..4ddcb40de899 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/docs/Update-AzHybridConnectivitySolutionConfiguration.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.HybridConnectivity +online version: https://learn.microsoft.com/powershell/module/az.hybridconnectivity/update-azhybridconnectivitysolutionconfiguration +schema: 2.0.0 +--- + +# Update-AzHybridConnectivitySolutionConfiguration + +## SYNOPSIS +update a SolutionConfiguration + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzHybridConnectivitySolutionConfiguration -ResourceUri -SolutionConfiguration + [-SolutionSetting ] [-SolutionType ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzHybridConnectivitySolutionConfiguration -InputObject + [-SolutionSetting ] [-SolutionType ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzHybridConnectivitySolutionConfiguration -ResourceUri -SolutionConfiguration + -JsonFilePath [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzHybridConnectivitySolutionConfiguration -ResourceUri -SolutionConfiguration + -JsonString [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +update a SolutionConfiguration + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.IHybridConnectivityIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceUri +The fully qualified Azure Resource manager identifier of the resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionConfiguration +Represent Solution Configuration Resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionSetting +Solution settings + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SolutionType +The type of the solution + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```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.HybridConnectivity.Models.IHybridConnectivityIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.HybridConnectivity.Models.ISolutionConfiguration + +## NOTES + +## RELATED LINKS + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityEndpoint.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityEndpoint.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityEndpoint.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityEndpointCredentials.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityEndpointCredentials.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityEndpointCredentials.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityEndpointIngressGatewayCredentials.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityEndpointIngressGatewayCredentials.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityEndpointIngressGatewayCredentials.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityEndpointManagedProxyDetail.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityEndpointManagedProxyDetail.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityEndpointManagedProxyDetail.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityInventory.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityInventory.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityInventory.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityPublicCloudConnector.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityPublicCloudConnector.md new file mode 100644 index 000000000000..f2f3c1e2ac9b --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityPublicCloudConnector.md @@ -0,0 +1,33 @@ +### Example 1: {{ Retrieve Details of a Public Cloud Connector }} +```powershell +Get-AzHybridConnectivityPublicCloudConnector ` + -PublicCloudConnector "MyTestConnector" ` + -ResourceGroupName "MyResourceGroup" +``` + +```output +Name : MyTestConnector +Id : /subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/MyResourceGroup/providers/Microsoft.HybridConnectivity/publicCloudConnectors/MyTestConnector +Location : eastus +ProvisioningState : Succeeded +AwsCloudProfile : @{accountId=123456789012; isOrganizationalAccount=False} +``` + +This command retrieves details of the Public Cloud Connector named MyTestConnector in the MyResourceGroup. + +### Example 2: {{ List All Public Cloud Connectors in a Resource Group }} +```powershell +Get-AzHybridConnectivityPublicCloudConnector -ResourceGroupName "MyResourceGroup" +``` + +```output +Name : MyTestConnector +Location : eastus +ProvisioningState : Succeeded +Name : MyTaggedConnector +Location : eastus +ProvisioningState : Succeeded +``` + +This command lists all Public Cloud Connectors in the MyResourceGroup. + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityServiceConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityServiceConfiguration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivityServiceConfiguration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivitySolutionConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivitySolutionConfiguration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivitySolutionConfiguration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivitySolutionType.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivitySolutionType.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Get-AzHybridConnectivitySolutionType.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Invoke-AzHybridConnectivityGenerateAwsTemplate.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Invoke-AzHybridConnectivityGenerateAwsTemplate.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Invoke-AzHybridConnectivityGenerateAwsTemplate.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/New-AzHybridConnectivityEndpoint.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/New-AzHybridConnectivityEndpoint.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/New-AzHybridConnectivityEndpoint.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/New-AzHybridConnectivityPublicCloudConnector.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/New-AzHybridConnectivityPublicCloudConnector.md new file mode 100644 index 000000000000..4d17aa92e2d4 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/New-AzHybridConnectivityPublicCloudConnector.md @@ -0,0 +1,55 @@ +### Example 1: {{ Creating a PublicCloudConnector Resource }} +```powershell +New-AzHybridConnectivityPublicCloudConnector ` + -PublicCloudConnector "MyTestConnector" ` + -ResourceGroupName "MyResourceGroup" ` + -Location "eastus" ` + -AwCloudProfileAccountId "123456789012" +``` + +```output +AwCloudProfileAccountId : 123456789012 +AwCloudProfileExcludedAccount : +AwCloudProfileIsOrganizationalAccount : False +ConnectorPrimaryIdentifier : c3387367-40f1-43a1-ad10-9666b6029c04 +HostType : AWS +Id : /subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/MyResourceGroup/providers/Microsoft.HybridConnectivity + /publicCloudConnectors/MyTestConnector +Location : eastus +Name : MyTestConnector +ProvisioningState : Succeeded +ResourceGroupName : MyResourceGroup +SystemDataCreatedAt : 16/1/2025 1:53:07 pm +SystemDataCreatedBy : user@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 16/1/2025 1:53:07 pm +SystemDataLastModifiedBy : user@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + } +Type : microsoft.hybridconnectivity/publiccloudconnectors +``` + +This command creates a Public Cloud Connector named MyTestConnector in the MyResourceGroup located in the eastus region. It uses a dummy AWS Cloud Profile Account ID 123456789012. + +### Example 2: {{ Creating a PublicCloudConnector Resource with Tags }} +```powershell +New-AzHybridConnectivityPublicCloudConnector ` + -PublicCloudConnector "MyTaggedConnector" ` + -ResourceGroupName "MyResourceGroup" ` + -Location "eastus" ` + -AwCloudProfileAccountId "760981343774" ` + -Tag @{ "Environment" = "Production"; "Purpose" = "Testing" } +``` + +```output +Name : MyTaggedConnector +Id : /subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/MyResourceGroup/providers/Microsoft.HybridConnectivity/publicCloudConnectors/MyTaggedConnector +Location : eastus +ProvisioningState : Succeeded +Tags : @{Environment=Production; Purpose=Testing} +AwsCloudProfile : @{accountId=760981343774; isOrganizationalAccount=False} +``` + +This command creates a Public Cloud Connector named MyTaggedConnector in the MyResourceGroup with Production and Testing tags. + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/New-AzHybridConnectivityServiceConfigurationOrupdate.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/New-AzHybridConnectivityServiceConfigurationOrupdate.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/New-AzHybridConnectivityServiceConfigurationOrupdate.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/New-AzHybridConnectivitySolutionConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/New-AzHybridConnectivitySolutionConfiguration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/New-AzHybridConnectivitySolutionConfiguration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Remove-AzHybridConnectivityEndpoint.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Remove-AzHybridConnectivityEndpoint.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Remove-AzHybridConnectivityEndpoint.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Remove-AzHybridConnectivityPublicCloudConnector.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Remove-AzHybridConnectivityPublicCloudConnector.md new file mode 100644 index 000000000000..7799f3795d63 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Remove-AzHybridConnectivityPublicCloudConnector.md @@ -0,0 +1,12 @@ +### Example 1: {{ Remove a Specific Public Cloud Connector }} +```powershell +Remove-AzHybridConnectivityPublicCloudConnector ` + -PublicCloudConnector "MyTestConnector" ` + -ResourceGroupName "MyResourceGroup" ` + -Force +``` + +```output +``` + +This command removes the MyTestConnector from the MyResourceGroup. The -Force parameter suppresses confirmation prompts. diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Remove-AzHybridConnectivityServiceConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Remove-AzHybridConnectivityServiceConfiguration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Remove-AzHybridConnectivityServiceConfiguration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Remove-AzHybridConnectivitySolutionConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Remove-AzHybridConnectivitySolutionConfiguration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Remove-AzHybridConnectivitySolutionConfiguration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Sync-AzHybridConnectivitySolutionConfigurationNow.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Sync-AzHybridConnectivitySolutionConfigurationNow.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Sync-AzHybridConnectivitySolutionConfigurationNow.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Test-AzHybridConnectivityPublicCloudConnectorPermission.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Test-AzHybridConnectivityPublicCloudConnectorPermission.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Test-AzHybridConnectivityPublicCloudConnectorPermission.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Update-AzHybridConnectivityEndpoint.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Update-AzHybridConnectivityEndpoint.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Update-AzHybridConnectivityEndpoint.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Update-AzHybridConnectivityPublicCloudConnector.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Update-AzHybridConnectivityPublicCloudConnector.md new file mode 100644 index 000000000000..d023f45d5781 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Update-AzHybridConnectivityPublicCloudConnector.md @@ -0,0 +1,32 @@ +### Example 1: {{ Update Tags for a Public Cloud Connector }} +```powershell +Update-AzHybridConnectivityPublicCloudConnector ` + -PublicCloudConnector "MyTestConnector" ` + -ResourceGroupName "MyResourceGroup" ` + -Tag @{ "Environment" = "Staging"; "Updated" = "True" } +``` + +```output +Name : MyTestConnector +Tags : @{Environment=Staging; Updated=True} +ProvisioningState : Succeeded +``` + +This command updates the tags for the MyTestConnector to include Staging and Updated. + +### Example 2: {{ Update a Public Cloud Connector’s Organizational Account }} +```powershell +Update-AzHybridConnectivityPublicCloudConnector ` + -PublicCloudConnector "MyTestConnector" ` + -ResourceGroupName "MyResourceGroup" ` + -AwCloudProfileIsOrganizationalAccount $true +``` + +```output +Name : MyTestConnector +AwsCloudProfile : @{accountId=123456789012; isOrganizationalAccount=True} +ProvisioningState : Succeeded +``` + +This command updates the MyTestConnector to set the AWS Cloud Profile as an organizational account. + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Update-AzHybridConnectivityServiceConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Update-AzHybridConnectivityServiceConfiguration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Update-AzHybridConnectivityServiceConfiguration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Update-AzHybridConnectivitySolutionConfiguration.md b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Update-AzHybridConnectivitySolutionConfiguration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/examples/Update-AzHybridConnectivitySolutionConfiguration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/how-to.md b/src/HybridConnectivity/HybridConnectivity.Autorest/how-to.md new file mode 100644 index 000000000000..d20a3b05ca7f --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/how-to.md @@ -0,0 +1,58 @@ +# How-To +This document describes how to develop for `Az.HybridConnectivity`. + +## Building `Az.HybridConnectivity` +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.HybridConnectivity` +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.HybridConnectivity` +To pack `Az.HybridConnectivity` 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://learn.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.HybridConnectivity`. +- `build-module.ps1` + - Builds the module DLL (`./bin/Az.HybridConnectivity.private.dll`), creates the exported cmdlets and documentation, generates custom cmdlet test stubs and exported cmdlet example stubs, and updates `./Az.HybridConnectivity.psd1` with Azure profile information. + - **Parameters**: [`Switch` parameters] + - `-Run`: After building, creates an isolated PowerShell session and loads `Az.HybridConnectivity`. + - `-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.HybridConnectivity` 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/src/HybridConnectivity/HybridConnectivity.Autorest/resources/README.md b/src/HybridConnectivity/HybridConnectivity.Autorest/resources/README.md new file mode 100644 index 000000000000..736492341e3d --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/resources/README.md @@ -0,0 +1,11 @@ +# Resources +This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `../custom` folder. + +## Info +- Modifiable: yes +- Generated: no +- Committed: yes +- Packaged: no + +## Purpose +Use this folder to put anything you want to keep around as part of the repository for the module, but is not something that is required for the module. For example, development files, packaged builds, or additional information. This is only intended to be used in repositories where the module's output directory is cleaned, but tangential resources for the module want to remain intact. \ No newline at end of file diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivityEndpoint.Tests.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivityEndpoint.Tests.ps1 new file mode 100644 index 000000000000..81c8f079c1fc --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivityEndpoint.Tests.ps1 @@ -0,0 +1,88 @@ +if(($null -eq $TestName) -or ($TestName -contains 'AzHybridConnectivityEndpoint')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'AzHybridConnectivityEndpoint.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +# Variables +$resourceUri = "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg" +$endpointName = "yashTestEndpoint" + +Describe 'AzHybridConnectivityEndpoint' { + + It 'Create, Get, Update, and Remove a Hybrid Connectivity Endpoint' -skip { + # Step 1: Create a new endpoint + $endpoint = New-AzHybridConnectivityEndpoint -Name $endpointName -ResourceUri $resourceUri + $endpoint | Should -Not -BeNullOrEmpty + + # Step 2: Get the created endpoint + $retrievedEndpoint = Get-AzHybridConnectivityEndpoint -Name $endpointName -ResourceUri $resourceUri + $retrievedEndpoint.Name | Should -Be $endpointName + + # Step 3: Update the endpoint (Example: Add tags) + $updatedEndpoint = Update-AzHybridConnectivityEndpoint -Name $endpointName -ResourceUri $resourceUri -Tag @{ "Environment" = "Test" } + $updatedEndpoint.Tags["Environment"] | Should -Be "Test" + + # Step 4: Get the updated endpoint + $retrievedUpdatedEndpoint = Get-AzHybridConnectivityEndpoint -Name $endpointName -ResourceUri $resourceUri + $retrievedUpdatedEndpoint.Tags["Environment"] | Should -Be "Test" + + # Step 5: Remove the endpoint + Remove-AzHybridConnectivityEndpoint -Name $endpointName -ResourceUri $resourceUri -Force | Out-Null + + # Step 6: Verify the endpoint no longer exists + { Get-AzHybridConnectivityEndpoint -Name $endpointName -ResourceUri $resourceUri } | Should -Throw + } + +# # Variables +# $resourceGroupName = "yashTestResourceGroup" +# $endpointName = "yashTestEndpoint" +# $location = "eastus" +# $resourceUri = "/subscriptions/$($env:AZURE_SUBSCRIPTION_ID)/resourceGroups/$resourceGroupName" + +# Describe 'AzHybridConnectivityEndpoint' { + +# BeforeAll { +# # Create a resource group +# New-AzResourceGroup -Name $resourceGroupName -Location $location | Out-Null +# } + +# AfterAll { +# # Clean up the resource group +# Remove-AzResourceGroup -Name $resourceGroupName -Force -AsJob | Out-Null +# } + +# It 'Create, Get, Update, and Remove a Hybrid Connectivity Endpoint' { +# # Step 1: Create a new endpoint +# $endpoint = New-AzHybridConnectivityEndpoint -Name $endpointName -ResourceUri $resourceUri +# $endpoint | Should -Not -BeNullOrEmpty + +# # Step 2: Get the created endpoint +# $retrievedEndpoint = Get-AzHybridConnectivityEndpoint -Name $endpointName -ResourceUri $resourceUri +# $retrievedEndpoint.Name | Should -Be $endpointName + +# # Step 3: Update the endpoint (Example: Add tags) +# $updatedEndpoint = Update-AzHybridConnectivityEndpoint -Name $endpointName -ResourceUri $resourceUri -Tag @{ "Environment" = "Test" } +# $updatedEndpoint.Tags["Environment"] | Should -Be "Test" + +# # Step 4: Get the updated endpoint +# $retrievedUpdatedEndpoint = Get-AzHybridConnectivityEndpoint -Name $endpointName -ResourceUri $resourceUri +# $retrievedUpdatedEndpoint.Tags["Environment"] | Should -Be "Test" + +# # Step 5: Remove the endpoint +# Remove-AzHybridConnectivityEndpoint -Name $endpointName -ResourceUri $resourceUri -Force | Out-Null + +# # Step 6: Verify the endpoint no longer exists +# { Get-AzHybridConnectivityEndpoint -Name $endpointName -ResourceUri $resourceUri } | Should -Throw +# } +} \ No newline at end of file diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivityPublicCloudConnector.Recording.json b/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivityPublicCloudConnector.Recording.json new file mode 100644 index 000000000000..8f221eecd9c8 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivityPublicCloudConnector.Recording.json @@ -0,0 +1,349 @@ +{ + "AzHybridConnectivityPublicCloudConnector+[NoContext]+Create, Get, Update, and Remove a Public Cloud Connector+$PUT+https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01+1": { + "Request": { + "Method": "PUT", + "RequestUri": "https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01", + "Content": "{\n \"tags\": {\n \"Purpose\": \"Testing\"\n },\n \"location\": \"eastus\",\n \"properties\": {\n \"awsCloudProfile\": {\n \"accountId\": \"123456789012\"\n },\n \"hostType\": \"AWS\"\n }\n}", + "isContentBase64": false, + "Headers": { + }, + "ContentHeaders": { + "Content-Type": [ "application/json" ], + "Content-Length": [ "179" ] + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"1d0475ee-0000-0100-0000-67890bde0000\"" ], + "x-ms-ratelimit-remaining-subscription-writes": [ "199" ], + "x-ms-providerhub-traffic": [ "True" ], + "mise-correlation-id": [ "88e54b81-47d3-4a46-999c-e8a99f164529" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Cache": [ "CONFIG_NOCACHE" ], + "X-MSEdge-Ref": [ "Ref A: B5C6C8808B244591A9E6D60595503AA4 Ref B: SYD03EDGE1016 Ref C: 2025-01-16T13:38:35Z" ], + "x-ms-request-id": [ "907f4a0a-99c6-4696-8573-fef84214312e" ], + "x-ms-correlation-request-id": [ "b0ec4c75-0b37-4475-a84b-21729f2f868c" ], + "x-ms-ratelimit-remaining-subscription-global-writes": [ "2999" ], + "x-ms-routing-request-id": [ "AUSTRALIAEAST:20250116T133839Z:b0ec4c75-0b37-4475-a84b-21729f2f868c" ], + "X-Content-Type-Options": [ "nosniff" ], + "Date": [ "Thu, 16 Jan 2025 13:38:39 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "769" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector\",\"name\":\"yashTestPublicCloudConnector\",\"type\":\"microsoft.hybridconnectivity/publiccloudconnectors\",\"location\":\"eastus\",\"tags\":{\"Purpose\":\"Testing\"},\"systemData\":{\"createdBy\":\"patilyash@microsoft.com\",\"createdByType\":\"User\",\"createdAt\":\"2025-01-16T13:38:37.2373718Z\",\"lastModifiedBy\":\"patilyash@microsoft.com\",\"lastModifiedByType\":\"User\",\"lastModifiedAt\":\"2025-01-16T13:38:37.2373718Z\"},\"properties\":{\"provisioningState\":\"Succeeded\",\"hostType\":\"AWS\",\"connectorPrimaryIdentifier\":\"f0b793d0-2247-4883-8d8d-60155b3b67bd\",\"awsCloudProfile\":{\"accountId\":\"123456789012\",\"isOrganizationalAccount\":false}}}", + "isContentBase64": false + } + }, + "AzHybridConnectivityPublicCloudConnector+[NoContext]+Create, Get, Update, and Remove a Public Cloud Connector+$GET+https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01+2": { + "Request": { + "Method": "GET", + "RequestUri": "https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01", + "Content": null, + "isContentBase64": false, + "Headers": { + "Authorization": [ "[Filtered]" ], + "x-ms-unique-id": [ "2" ], + "x-ms-client-request-id": [ "8a372cde-dda3-4d90-b08f-f36fac25358c" ], + "CommandName": [ "New-AzHybridConnectivityPublicCloudConnector" ], + "FullCommandName": [ "New-AzHybridConnectivityPublicCloudConnector_CreateExpanded" ], + "ParameterSetName": [ "__AllParameterSets" ], + "User-Agent": [ "AzurePowershell/v12.3.0", "PSVersion/v7.4.5", "Az.HybridConnectivity/0.0.0" ] + }, + "ContentHeaders": { + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"1d0475ee-0000-0100-0000-67890bde0000\"" ], + "x-ms-ratelimit-remaining-subscription-reads": [ "249" ], + "x-ms-providerhub-traffic": [ "True" ], + "x-ms-request-id": [ "cf7e1b10-c2d8-4009-8e7f-fd10958a8f59" ], + "x-ms-correlation-request-id": [ "edc51ef0-330a-4cff-8705-dcce76ce913e" ], + "x-ms-ratelimit-remaining-subscription-global-reads": [ "3749" ], + "x-ms-routing-request-id": [ "AUSTRALIAEAST:20250116T133910Z:edc51ef0-330a-4cff-8705-dcce76ce913e" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "X-Cache": [ "CONFIG_NOCACHE" ], + "X-MSEdge-Ref": [ "Ref A: DFA046FD2FE84E45B9549026DA50C284 Ref B: SYD03EDGE1016 Ref C: 2025-01-16T13:39:09Z" ], + "Date": [ "Thu, 16 Jan 2025 13:39:10 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "769" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector\",\"name\":\"yashTestPublicCloudConnector\",\"type\":\"microsoft.hybridconnectivity/publiccloudconnectors\",\"location\":\"eastus\",\"tags\":{\"Purpose\":\"Testing\"},\"systemData\":{\"createdBy\":\"patilyash@microsoft.com\",\"createdByType\":\"User\",\"createdAt\":\"2025-01-16T13:38:37.2373718Z\",\"lastModifiedBy\":\"patilyash@microsoft.com\",\"lastModifiedByType\":\"User\",\"lastModifiedAt\":\"2025-01-16T13:38:37.2373718Z\"},\"properties\":{\"provisioningState\":\"Succeeded\",\"hostType\":\"AWS\",\"connectorPrimaryIdentifier\":\"f0b793d0-2247-4883-8d8d-60155b3b67bd\",\"awsCloudProfile\":{\"accountId\":\"123456789012\",\"isOrganizationalAccount\":false}}}", + "isContentBase64": false + } + }, + "AzHybridConnectivityPublicCloudConnector+[NoContext]+Create, Get, Update, and Remove a Public Cloud Connector+$GET+https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01+3": { + "Request": { + "Method": "GET", + "RequestUri": "https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01", + "Content": null, + "isContentBase64": false, + "Headers": { + "Authorization": [ "[Filtered]" ], + "x-ms-unique-id": [ "3" ], + "x-ms-client-request-id": [ "8a372cde-dda3-4d90-b08f-f36fac25358c" ], + "CommandName": [ "New-AzHybridConnectivityPublicCloudConnector" ], + "FullCommandName": [ "New-AzHybridConnectivityPublicCloudConnector_CreateExpanded" ], + "ParameterSetName": [ "__AllParameterSets" ], + "User-Agent": [ "AzurePowershell/v12.3.0", "PSVersion/v7.4.5", "Az.HybridConnectivity/0.0.0" ] + }, + "ContentHeaders": { + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"1d0475ee-0000-0100-0000-67890bde0000\"" ], + "x-ms-ratelimit-remaining-subscription-reads": [ "249" ], + "x-ms-providerhub-traffic": [ "True" ], + "x-ms-request-id": [ "ced8bd14-31ec-422e-b9f5-f5d1b7b8b3c5" ], + "x-ms-correlation-request-id": [ "6b3af74b-b228-4875-9b19-603145c05bf2" ], + "x-ms-ratelimit-remaining-subscription-global-reads": [ "3749" ], + "x-ms-routing-request-id": [ "AUSTRALIAEAST:20250116T133911Z:6b3af74b-b228-4875-9b19-603145c05bf2" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "X-Cache": [ "CONFIG_NOCACHE" ], + "X-MSEdge-Ref": [ "Ref A: CFAC34556DAC4D2590B986FF3D8389BE Ref B: SYD03EDGE1016 Ref C: 2025-01-16T13:39:10Z" ], + "Date": [ "Thu, 16 Jan 2025 13:39:11 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "769" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector\",\"name\":\"yashTestPublicCloudConnector\",\"type\":\"microsoft.hybridconnectivity/publiccloudconnectors\",\"location\":\"eastus\",\"tags\":{\"Purpose\":\"Testing\"},\"systemData\":{\"createdBy\":\"patilyash@microsoft.com\",\"createdByType\":\"User\",\"createdAt\":\"2025-01-16T13:38:37.2373718Z\",\"lastModifiedBy\":\"patilyash@microsoft.com\",\"lastModifiedByType\":\"User\",\"lastModifiedAt\":\"2025-01-16T13:38:37.2373718Z\"},\"properties\":{\"provisioningState\":\"Succeeded\",\"hostType\":\"AWS\",\"connectorPrimaryIdentifier\":\"f0b793d0-2247-4883-8d8d-60155b3b67bd\",\"awsCloudProfile\":{\"accountId\":\"123456789012\",\"isOrganizationalAccount\":false}}}", + "isContentBase64": false + } + }, + "AzHybridConnectivityPublicCloudConnector+[NoContext]+Create, Get, Update, and Remove a Public Cloud Connector+$GET+https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01+4": { + "Request": { + "Method": "GET", + "RequestUri": "https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01", + "Content": null, + "isContentBase64": false, + "Headers": { + "x-ms-unique-id": [ "4" ], + "x-ms-client-request-id": [ "c802dee3-2bfe-4789-9eeb-f286d60d2bd7" ], + "CommandName": [ "Get-AzHybridConnectivityPublicCloudConnector" ], + "FullCommandName": [ "Get-AzHybridConnectivityPublicCloudConnector_Get" ], + "ParameterSetName": [ "__AllParameterSets" ], + "User-Agent": [ "AzurePowershell/v12.3.0", "PSVersion/v7.4.5", "Az.HybridConnectivity/0.0.0" ], + "Authorization": [ "[Filtered]" ] + }, + "ContentHeaders": { + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"1d0475ee-0000-0100-0000-67890bde0000\"" ], + "x-ms-ratelimit-remaining-subscription-reads": [ "249" ], + "x-ms-providerhub-traffic": [ "True" ], + "x-ms-request-id": [ "2f5e2918-15a1-4195-8856-6253ee5d8b03" ], + "x-ms-correlation-request-id": [ "263f7524-687c-4154-81f3-04ebd159d04a" ], + "x-ms-ratelimit-remaining-subscription-global-reads": [ "3749" ], + "x-ms-routing-request-id": [ "AUSTRALIAEAST:20250116T133912Z:263f7524-687c-4154-81f3-04ebd159d04a" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "X-Cache": [ "CONFIG_NOCACHE" ], + "X-MSEdge-Ref": [ "Ref A: 97CBE04728E1432E8ABCEE40733CC48F Ref B: SYD03EDGE1016 Ref C: 2025-01-16T13:39:11Z" ], + "Date": [ "Thu, 16 Jan 2025 13:39:11 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "769" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector\",\"name\":\"yashTestPublicCloudConnector\",\"type\":\"microsoft.hybridconnectivity/publiccloudconnectors\",\"location\":\"eastus\",\"tags\":{\"Purpose\":\"Testing\"},\"systemData\":{\"createdBy\":\"patilyash@microsoft.com\",\"createdByType\":\"User\",\"createdAt\":\"2025-01-16T13:38:37.2373718Z\",\"lastModifiedBy\":\"patilyash@microsoft.com\",\"lastModifiedByType\":\"User\",\"lastModifiedAt\":\"2025-01-16T13:38:37.2373718Z\"},\"properties\":{\"provisioningState\":\"Succeeded\",\"hostType\":\"AWS\",\"connectorPrimaryIdentifier\":\"f0b793d0-2247-4883-8d8d-60155b3b67bd\",\"awsCloudProfile\":{\"accountId\":\"123456789012\",\"isOrganizationalAccount\":false}}}", + "isContentBase64": false + } + }, + "AzHybridConnectivityPublicCloudConnector+[NoContext]+Create, Get, Update, and Remove a Public Cloud Connector+$PATCH+https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01+5": { + "Request": { + "Method": "PATCH", + "RequestUri": "https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01", + "Content": "{\n \"tags\": {\n \"Purpose\": \"Testing\",\n \"Environment\": \"Production\"\n }\n}", + "isContentBase64": false, + "Headers": { + }, + "ContentHeaders": { + "Content-Type": [ "application/json" ], + "Content-Length": [ "77" ] + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"1e049205-0000-0100-0000-67890c020000\"" ], + "x-ms-ratelimit-remaining-subscription-writes": [ "199" ], + "x-ms-providerhub-traffic": [ "True" ], + "x-ms-request-id": [ "2bca2754-c7f2-4926-98c0-f745801d7216" ], + "x-ms-correlation-request-id": [ "f090b605-5730-4a5c-ba49-b74f8db96091" ], + "x-ms-ratelimit-remaining-subscription-global-writes": [ "2999" ], + "x-ms-routing-request-id": [ "AUSTRALIAEAST:20250116T133916Z:f090b605-5730-4a5c-ba49-b74f8db96091" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "X-Cache": [ "CONFIG_NOCACHE" ], + "X-MSEdge-Ref": [ "Ref A: D57C0074DA16483AB92CE1B8455A7E46 Ref B: SYD03EDGE1016 Ref C: 2025-01-16T13:39:12Z" ], + "Date": [ "Thu, 16 Jan 2025 13:39:15 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "796" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector\",\"name\":\"yashTestPublicCloudConnector\",\"type\":\"microsoft.hybridconnectivity/publiccloudconnectors\",\"location\":\"eastus\",\"tags\":{\"Purpose\":\"Testing\",\"Environment\":\"Production\"},\"systemData\":{\"createdBy\":\"patilyash@microsoft.com\",\"createdByType\":\"User\",\"createdAt\":\"2025-01-16T13:38:37.2373718Z\",\"lastModifiedBy\":\"patilyash@microsoft.com\",\"lastModifiedByType\":\"User\",\"lastModifiedAt\":\"2025-01-16T13:39:14.1638618Z\"},\"properties\":{\"provisioningState\":\"Succeeded\",\"hostType\":\"AWS\",\"connectorPrimaryIdentifier\":\"f0b793d0-2247-4883-8d8d-60155b3b67bd\",\"awsCloudProfile\":{\"accountId\":\"123456789012\",\"isOrganizationalAccount\":false}}}", + "isContentBase64": false + } + }, + "AzHybridConnectivityPublicCloudConnector+[NoContext]+Create, Get, Update, and Remove a Public Cloud Connector+$GET+https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01+6": { + "Request": { + "Method": "GET", + "RequestUri": "https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01", + "Content": null, + "isContentBase64": false, + "Headers": { + "x-ms-unique-id": [ "6" ], + "x-ms-client-request-id": [ "d6bde267-6e44-4464-9299-171c301a9e5e" ], + "CommandName": [ "Get-AzHybridConnectivityPublicCloudConnector" ], + "FullCommandName": [ "Get-AzHybridConnectivityPublicCloudConnector_Get" ], + "ParameterSetName": [ "__AllParameterSets" ], + "User-Agent": [ "AzurePowershell/v12.3.0", "PSVersion/v7.4.5", "Az.HybridConnectivity/0.0.0" ], + "Authorization": [ "[Filtered]" ] + }, + "ContentHeaders": { + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"1e049205-0000-0100-0000-67890c020000\"" ], + "x-ms-ratelimit-remaining-subscription-reads": [ "248" ], + "x-ms-providerhub-traffic": [ "True" ], + "x-ms-request-id": [ "8b60b61c-95cd-448a-a097-0d55e7458006" ], + "x-ms-correlation-request-id": [ "b6ab4012-c2af-4d2d-941a-21787b93c632" ], + "x-ms-ratelimit-remaining-subscription-global-reads": [ "3748" ], + "x-ms-routing-request-id": [ "AUSTRALIAEAST:20250116T133916Z:b6ab4012-c2af-4d2d-941a-21787b93c632" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "X-Cache": [ "CONFIG_NOCACHE" ], + "X-MSEdge-Ref": [ "Ref A: FB31C2E0B3F4495AB455C7D3D11233C0 Ref B: SYD03EDGE1016 Ref C: 2025-01-16T13:39:16Z" ], + "Date": [ "Thu, 16 Jan 2025 13:39:16 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "796" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector\",\"name\":\"yashTestPublicCloudConnector\",\"type\":\"microsoft.hybridconnectivity/publiccloudconnectors\",\"location\":\"eastus\",\"tags\":{\"Purpose\":\"Testing\",\"Environment\":\"Production\"},\"systemData\":{\"createdBy\":\"patilyash@microsoft.com\",\"createdByType\":\"User\",\"createdAt\":\"2025-01-16T13:38:37.2373718Z\",\"lastModifiedBy\":\"patilyash@microsoft.com\",\"lastModifiedByType\":\"User\",\"lastModifiedAt\":\"2025-01-16T13:39:14.1638618Z\"},\"properties\":{\"provisioningState\":\"Succeeded\",\"hostType\":\"AWS\",\"connectorPrimaryIdentifier\":\"f0b793d0-2247-4883-8d8d-60155b3b67bd\",\"awsCloudProfile\":{\"accountId\":\"123456789012\",\"isOrganizationalAccount\":false}}}", + "isContentBase64": false + } + }, + "AzHybridConnectivityPublicCloudConnector+[NoContext]+Create, Get, Update, and Remove a Public Cloud Connector+$DELETE+https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01+7": { + "Request": { + "Method": "DELETE", + "RequestUri": "https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01", + "Content": null, + "isContentBase64": false, + "Headers": { + "x-ms-unique-id": [ "7" ], + "x-ms-client-request-id": [ "5b6abfc5-c0b6-4052-8208-657fddfe4a3d" ], + "CommandName": [ "Remove-AzHybridConnectivityPublicCloudConnector" ], + "FullCommandName": [ "Remove-AzHybridConnectivityPublicCloudConnector_Delete" ], + "ParameterSetName": [ "__AllParameterSets" ], + "User-Agent": [ "AzurePowershell/v12.3.0", "PSVersion/v7.4.5", "Az.HybridConnectivity/0.0.0" ], + "Authorization": [ "[Filtered]" ] + }, + "ContentHeaders": { + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "x-ms-providerhub-traffic": [ "True" ], + "mise-correlation-id": [ "74090417-2ade-4433-828e-714f5c926c8b" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Cache": [ "CONFIG_NOCACHE" ], + "X-MSEdge-Ref": [ "Ref A: 407166AAEB5B4D6AA8056EE3F76C6508 Ref B: SYD03EDGE1016 Ref C: 2025-01-16T13:39:16Z" ], + "x-ms-request-id": [ "00000000-0000-0000-0000-000000000000" ], + "x-ms-ratelimit-remaining-subscription-deletes": [ "199" ], + "x-ms-ratelimit-remaining-subscription-global-deletes": [ "2999" ], + "x-ms-correlation-request-id": [ "ee23cc92-4c6c-453b-ab23-3439589180b0" ], + "x-ms-routing-request-id": [ "AUSTRALIAEAST:20250116T133922Z:ee23cc92-4c6c-453b-ab23-3439589180b0" ], + "X-Content-Type-Options": [ "nosniff" ], + "Date": [ "Thu, 16 Jan 2025 13:39:21 GMT" ] + }, + "ContentHeaders": { + "Expires": [ "-1" ], + "Content-Length": [ "0" ] + }, + "Content": null, + "isContentBase64": false + } + }, + "AzHybridConnectivityPublicCloudConnector+[NoContext]+Create, Get, Update, and Remove a Public Cloud Connector+$GET+https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01+8": { + "Request": { + "Method": "GET", + "RequestUri": "https://management.azure.com/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/yash-rg/providers/Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector?api-version=2024-12-01", + "Content": null, + "isContentBase64": false, + "Headers": { + "x-ms-unique-id": [ "8" ], + "x-ms-client-request-id": [ "32ac5b70-9b18-47ec-85cd-728802401a5a" ], + "CommandName": [ "Get-AzHybridConnectivityPublicCloudConnector" ], + "FullCommandName": [ "Get-AzHybridConnectivityPublicCloudConnector_Get" ], + "ParameterSetName": [ "__AllParameterSets" ], + "User-Agent": [ "AzurePowershell/v12.3.0", "PSVersion/v7.4.5", "Az.HybridConnectivity/0.0.0" ], + "Authorization": [ "[Filtered]" ] + }, + "ContentHeaders": { + } + }, + "Response": { + "StatusCode": 404, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "x-ms-failure-cause": [ "gateway" ], + "x-ms-request-id": [ "289da50a-4060-48ab-ac6c-96ee83db5f0e" ], + "x-ms-correlation-request-id": [ "289da50a-4060-48ab-ac6c-96ee83db5f0e" ], + "x-ms-routing-request-id": [ "AUSTRALIAEAST:20250116T133922Z:289da50a-4060-48ab-ac6c-96ee83db5f0e" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "X-Cache": [ "CONFIG_NOCACHE" ], + "X-MSEdge-Ref": [ "Ref A: F18720FDC1A44E77A59A23D44DFF41C5 Ref B: SYD03EDGE1016 Ref C: 2025-01-16T13:39:22Z" ], + "Date": [ "Thu, 16 Jan 2025 13:39:22 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "258" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"error\":{\"code\":\"ResourceNotFound\",\"message\":\"The Resource \u0027Microsoft.HybridConnectivity/publicCloudConnectors/yashTestPublicCloudConnector\u0027 under resource group \u0027yash-rg\u0027 was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix\"}}", + "isContentBase64": false + } + } +} \ No newline at end of file diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivityPublicCloudConnector.Tests.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivityPublicCloudConnector.Tests.ps1 new file mode 100644 index 000000000000..0cf3b7f43123 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivityPublicCloudConnector.Tests.ps1 @@ -0,0 +1,66 @@ +if(($null -eq $TestName) -or ($TestName -contains 'AzHybridConnectivityPublicCloudConnector')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'AzHybridConnectivityPublicCloudConnector.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +# Variables +$connectorName = "yashTestPublicCloudConnector" +$resourceGroupName = "yash-rg" +$mockAwCloudProfile = "123456789012" +$location = "eastus" + +Describe 'AzHybridConnectivityPublicCloudConnector' { + + It 'Create, Get, Update, and Remove a Public Cloud Connector' { + # Step 1: Create a new Public Cloud Connector + $connector = New-AzHybridConnectivityPublicCloudConnector ` + -PublicCloudConnector $connectorName ` + -ResourceGroupName $resourceGroupName ` + -Location $location ` + -AwCloudProfileAccountId $mockAwCloudProfile ` + -Tag @{ "Purpose" = "Testing" } + $connector | Should -Not -BeNullOrEmpty + + # Step 2: Get the created Public Cloud Connector + $retrievedConnector = Get-AzHybridConnectivityPublicCloudConnector ` + -PublicCloudConnector $connectorName ` + -ResourceGroupName $resourceGroupName + $retrievedConnector.Name | Should -Be $connectorName + + # Step 3: Update the Public Cloud Connector (Example: Add additional tags) + $updatedConnector = Update-AzHybridConnectivityPublicCloudConnector ` + -PublicCloudConnector $connectorName ` + -ResourceGroupName $resourceGroupName ` + -Tag @{ "Purpose" = "Testing"; "Environment" = "Production" } | ConvertFrom-Json + + $updatedConnector.tags.Environment | Should -Be "Production" + + # Step 4: Get the updated Public Cloud Connector + $retrievedUpdatedConnector = Get-AzHybridConnectivityPublicCloudConnector ` + -PublicCloudConnector $connectorName ` + -ResourceGroupName $resourceGroupName | ConvertFrom-Json + + $retrievedUpdatedConnector.tags.Environment | Should -Be "Production" + + # Step 5: Remove the Public Cloud Connector + Remove-AzHybridConnectivityPublicCloudConnector ` + -PublicCloudConnector $connectorName ` + -ResourceGroupName $resourceGroupName ` | Out-Null + + # Step 6: Verify the connector no longer exists + { Get-AzHybridConnectivityPublicCloudConnector ` + -PublicCloudConnector $connectorName ` + -ResourceGroupName $resourceGroupName } | Should -Throw + } +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivityServiceConfiguration.Tests.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivityServiceConfiguration.Tests.ps1 new file mode 100644 index 000000000000..ed8cb64d3dce --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivityServiceConfiguration.Tests.ps1 @@ -0,0 +1,83 @@ +if(($null -eq $TestName) -or ($TestName -contains 'AzHybridConnectivityServiceConfiguration')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'AzHybridConnectivityServiceConfiguration.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +# Variables +$resourceGroupName = "yashTestResourceGroup" +$serviceConfigName = "yashTestServiceConfig" +$endpointName = "yashTestEndpoint" +$location = "eastus" +$resourceUri = "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/$resourceGroupName" + +Describe 'AzHybridConnectivityServiceConfiguration' { + + It 'Create, Get, Update, and Remove a Service Configuration' -skip { + # Step 1: Create a new Service Configuration + Write-Host "Starting: Creating a new Service Configuration..." + Write-Host "ResourceUri: $resourceUri" + + $serviceConfig = New-AzHybridConnectivityServiceConfigurationOrupdate ` + -EndpointName $endpointName ` + -ResourceUri $resourceUri ` + -ServiceConfigurationName $serviceConfigName + + $serviceConfig | Should -Not -BeNullOrEmpty + Write-Host "Completed: Service Configuration created successfully." + + # Step 2: Get the created Service Configuration + Write-Host "Starting: Retrieving the created Service Configuration..." + $retrievedServiceConfig = Get-AzHybridConnectivityServiceConfiguration ` + -EndpointName $endpointName ` + -ResourceUri $resourceUri + + $retrievedServiceConfig.Name | Should -Be $serviceConfigName + Write-Host "Completed: Retrieved Service Configuration successfully." + + # Step 3: Update the Service Configuration (Example: Add tags) + Write-Host "Starting: Updating the Service Configuration with additional tags..." + $updatedServiceConfig = Update-AzHybridConnectivityServiceConfiguration ` + -EndpointName $endpointName ` + -Name $serviceConfigName ` + -ResourceUri $resourceUri | ConvertFrom-Json + + $updatedServiceConfig.tags.Environment | Should -Be "Production" + Write-Host "Completed: Service Configuration updated successfully." + + # Step 4: Get the updated Service Configuration + Write-Host "Starting: Retrieving the updated Service Configuration..." + $retrievedUpdatedServiceConfig = Get-AzHybridConnectivityServiceConfiguration ` + -EndpointName $endpointName ` + -ResourceUri $resourceUri | ConvertFrom-Json + + $retrievedUpdatedServiceConfig.tags.Environment | Should -Be "Production" + Write-Host "Completed: Retrieved updated Service Configuration successfully." + + # Step 5: Remove the Service Configuration + Write-Host "Starting: Removing the Service Configuration..." + Remove-AzHybridConnectivityServiceConfiguration ` + -EndpointName $endpointName ` + -Name $serviceConfigName ` + -ResourceUri $resourceUri | Out-Null + Write-Host "Completed: Service Configuration removed successfully." + + # Step 6: Verify the configuration no longer exists + Write-Host "Starting: Verifying that the Service Configuration no longer exists..." + { Get-AzHybridConnectivityServiceConfiguration ` + -EndpointName $endpointName ` + -ResourceUri $resourceUri } | Should -Throw + + Write-Host "Completed: Verification successful, Service Configuration no longer exists." + } +} \ No newline at end of file diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivitySolutionConfiguration.Tests.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivitySolutionConfiguration.Tests.ps1 new file mode 100644 index 000000000000..0eaaef3c629f --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/AzHybridConnectivitySolutionConfiguration.Tests.ps1 @@ -0,0 +1,70 @@ +if(($null -eq $TestName) -or ($TestName -contains 'AzHybridConnectivitySolutionConfiguration')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'AzHybridConnectivitySolutionConfiguration.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +# Variables +$resourceGroupName = "yashTestResourceGroup" +$solutionName = "yashTestSolutionConfiguration" +$location = "eastus" +$resourceUri = "/subscriptions/0b1f6471-1bf0-4dda-aec3-cb9272f09590/resourceGroups/$resourceGroupName" + +Describe 'AzHybridConnectivitySolutionConfiguration' { + + It 'Create, Get, Update, and Remove a Solution Configuration' -skip { + # Step 1: Create a new Solution Configuration + Write-Host "Starting: Creating a new Solution Configuration..." + $solution = New-AzHybridConnectivitySolutionConfiguration ` + -ResourceUri $resourceUri ` + -SolutionConfiguration $solutionName + $solution | Should -Not -BeNullOrEmpty + Write-Host "Completed: Solution Configuration created successfully." + + # Step 2: Get the created Solution Configuration + Write-Host "Starting: Retrieving the created Solution Configuration..." + $retrievedSolution = Get-AzHybridConnectivitySolutionConfiguration ` + -ResourceUri $resourceUri + $retrievedSolution | Should -Not -BeNullOrEmpty + Write-Host "Completed: Retrieved Solution Configuration successfully." + + # Step 3: Update the Solution Configuration + Write-Host "Starting: Updating the Solution Configuration..." + $updatedSolution = Update-AzHybridConnectivitySolutionConfiguration ` + -ResourceUri $resourceUri ` + -SolutionConfiguration $solutionName + $updatedSolution | Should -Not -BeNullOrEmpty + Write-Host "Completed: Solution Configuration updated successfully." + + # Step 4: Get the updated Solution Configuration + Write-Host "Starting: Retrieving the updated Solution Configuration..." + $retrievedUpdatedSolution = Get-AzHybridConnectivitySolutionConfiguration ` + -ResourceUri $resourceUri + $retrievedUpdatedSolution | Should -Not -BeNullOrEmpty + Write-Host "Completed: Retrieved updated Solution Configuration successfully." + + # Step 5: Remove the Solution Configuration + Write-Host "Starting: Removing the Solution Configuration..." + Remove-AzHybridConnectivitySolutionConfiguration ` + -ResourceUri $resourceUri ` + -SolutionConfiguration $solutionName ` + -Force | Out-Null + Write-Host "Completed: Solution Configuration removed successfully." + + # Step 6: Verify the Solution Configuration no longer exists + Write-Host "Starting: Verifying that the Solution Configuration no longer exists..." + { Get-AzHybridConnectivitySolutionConfiguration ` + -ResourceUri $resourceUri } | Should -Throw + Write-Host "Completed: Verification successful, Solution Configuration no longer exists." + } +} \ No newline at end of file diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivityEndpointCredentials.Tests.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivityEndpointCredentials.Tests.ps1 new file mode 100644 index 000000000000..6630baad5983 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivityEndpointCredentials.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzHybridConnectivityEndpointCredentials')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzHybridConnectivityEndpointCredentials.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzHybridConnectivityEndpointCredentials' { + It 'ListExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ListViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ListViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivityEndpointIngressGatewayCredentials.Tests.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivityEndpointIngressGatewayCredentials.Tests.ps1 new file mode 100644 index 000000000000..efdf9f2ccbb8 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivityEndpointIngressGatewayCredentials.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzHybridConnectivityEndpointIngressGatewayCredentials')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzHybridConnectivityEndpointIngressGatewayCredentials.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzHybridConnectivityEndpointIngressGatewayCredentials' { + It 'ListExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ListViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ListViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivityEndpointManagedProxyDetail.Tests.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivityEndpointManagedProxyDetail.Tests.ps1 new file mode 100644 index 000000000000..4b896a6e5227 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivityEndpointManagedProxyDetail.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzHybridConnectivityEndpointManagedProxyDetail')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzHybridConnectivityEndpointManagedProxyDetail.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzHybridConnectivityEndpointManagedProxyDetail' { + It 'ListExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ListViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ListViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivityInventory.Tests.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivityInventory.Tests.ps1 new file mode 100644 index 000000000000..f3068e17540f --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivityInventory.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzHybridConnectivityInventory')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzHybridConnectivityInventory.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzHybridConnectivityInventory' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentitySolutionConfiguration' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivitySolutionType.Tests.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivitySolutionType.Tests.ps1 new file mode 100644 index 000000000000..312b8221fc40 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Get-AzHybridConnectivitySolutionType.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzHybridConnectivitySolutionType')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzHybridConnectivitySolutionType.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzHybridConnectivitySolutionType' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'List1' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/Invoke-AzHybridConnectivityGenerateAwsTemplate.Tests.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Invoke-AzHybridConnectivityGenerateAwsTemplate.Tests.ps1 new file mode 100644 index 000000000000..e45bcea16a2a --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Invoke-AzHybridConnectivityGenerateAwsTemplate.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Invoke-AzHybridConnectivityGenerateAwsTemplate')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Invoke-AzHybridConnectivityGenerateAwsTemplate.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Invoke-AzHybridConnectivityGenerateAwsTemplate' { + It 'PostExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Post' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'PostViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'PostViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/README.md b/src/HybridConnectivity/HybridConnectivity.Autorest/test/README.md new file mode 100644 index 000000000000..1969200c6a09 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/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/src/HybridConnectivity/HybridConnectivity.Autorest/test/Sync-AzHybridConnectivitySolutionConfigurationNow.Tests.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Sync-AzHybridConnectivitySolutionConfigurationNow.Tests.ps1 new file mode 100644 index 000000000000..5e17cc8b6e08 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Sync-AzHybridConnectivitySolutionConfigurationNow.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Sync-AzHybridConnectivitySolutionConfigurationNow')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Sync-AzHybridConnectivitySolutionConfigurationNow.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Sync-AzHybridConnectivitySolutionConfigurationNow' { + It 'Sync' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'SyncViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/Test-AzHybridConnectivityPublicCloudConnectorPermission.Tests.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Test-AzHybridConnectivityPublicCloudConnectorPermission.Tests.ps1 new file mode 100644 index 000000000000..3480ac29663c --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/Test-AzHybridConnectivityPublicCloudConnectorPermission.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Test-AzHybridConnectivityPublicCloudConnectorPermission')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Test-AzHybridConnectivityPublicCloudConnectorPermission.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Test-AzHybridConnectivityPublicCloudConnectorPermission' { + It 'Test' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'TestViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/env.json b/src/HybridConnectivity/HybridConnectivity.Autorest/test/env.json new file mode 100644 index 000000000000..83661d7800aa --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/env.json @@ -0,0 +1,4 @@ +{ + "Tenant": "54826b22-38d6-4fb2-bad9-b7b93a3e9c5a", + "SubscriptionId": "0b1f6471-1bf0-4dda-aec3-cb9272f09590" +} diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/loadEnv.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/loadEnv.ps1 new file mode 100644 index 000000000000..6a7c385c6b7d --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/loadEnv.ps1 @@ -0,0 +1,29 @@ +# ---------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# http://www.apache.org/licenses/LICENSE-2.0 +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +# is regenerated. +# ---------------------------------------------------------------------------------- +$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=@{"*:Tenant"=$env.Tenant} +} \ No newline at end of file diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/test/utils.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/test/utils.ps1 new file mode 100644 index 000000000000..f8497fbd7da0 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/test/utils.ps1 @@ -0,0 +1,56 @@ +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]$_}) + } +} +function Start-TestSleep { + [CmdletBinding(DefaultParameterSetName = 'SleepBySeconds')] + param( + [parameter(Mandatory = $true, Position = 0, ParameterSetName = 'SleepBySeconds')] + [ValidateRange(0.0, 2147483.0)] + [double] $Seconds, + + [parameter(Mandatory = $true, ParameterSetName = 'SleepByMilliseconds')] + [ValidateRange('NonNegative')] + [Alias('ms')] + [int] $Milliseconds + ) + + if ($TestMode -ne 'playback') { + switch ($PSCmdlet.ParameterSetName) { + 'SleepBySeconds' { + Start-Sleep -Seconds $Seconds + } + 'SleepByMilliseconds' { + Start-Sleep -Milliseconds $Milliseconds + } + } + } +} + +$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/src/HybridConnectivity/HybridConnectivity.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 new file mode 100644 index 000000000000..5319862d3372 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 @@ -0,0 +1,7 @@ +param() +if ($env:AzPSAutorestTestPlaybackMode) { + $loadEnvPath = Join-Path $PSScriptRoot '..' 'test' 'loadEnv.ps1' + . ($loadEnvPath) + return $env.SubscriptionId +} +return (Get-AzContext).Subscription.Id \ No newline at end of file diff --git a/src/HybridConnectivity/HybridConnectivity.Autorest/utils/Unprotect-SecureString.ps1 b/src/HybridConnectivity/HybridConnectivity.Autorest/utils/Unprotect-SecureString.ps1 new file mode 100644 index 000000000000..cb05b51a6220 --- /dev/null +++ b/src/HybridConnectivity/HybridConnectivity.Autorest/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