diff --git a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareCluster.md b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareCluster.md index cb03702cb266..de1abc1d7292 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareCluster.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareCluster.md @@ -14,32 +14,26 @@ Implements cluster GET method. ### List (Default) ``` -Get-AzConnectedVMwareCluster [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareCluster [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzConnectedVMwareCluster -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List1 ``` Get-AzConnectedVMwareCluster -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzConnectedVMwareCluster -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareCluster -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -47,37 +41,89 @@ Implements cluster GET method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List Clusters in current subscription +```powershell Get-AzConnectedVMwareCluster -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 2 +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-cluster1 test-rg1 + eastus test-cluster2 test-rg2 + eastus test-cluster3 test-rg3 + eastus test-cluster4 test-rg4 + eastus test-cluster5 test-rg5 + eastus test-cluster6 test-rg6 + eastus test-cluster7 test-rg7 + eastus test-cluster8 test-rg8 ``` + +This command lists Clusters in current subscription. + +### Example 2: List Clusters in a resource group +```powershell Get-AzConnectedVMwareCluster -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 3 -``` -Get-AzConnectedVMwareCluster -Name "test-cluster" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-cluster1 test-rg + eastus test-cluster2 test-rg ``` -## PARAMETERS +This command lists Clusters in a resource group named `test-rg`. -### -Break -Wait for .NET debugger to attach +### Example 3: Get a specific Cluster +```powershell +Get-AzConnectedVMwareCluster -Name "test-cluster" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +```output +CustomResourceName : dd163232-210f-4f82-8b0c-9866a2eac862 +DatastoreId : +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/clusters/test-cluster +InventoryItemId : +Kind : +Location : eastus2euap +MoName : Cluster-1 +MoRefId : domain-c7 +Name : test-cluster +NetworkId : +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2021-08-25T09:48:12.9989085Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2021-08-25T09:48:12.9989085Z" + }} +SystemDataCreatedAt : 8/25/2021 9:38:06 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/25/2021 9:48:13 AM +SystemDataLastModifiedBy : ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 +SystemDataLastModifiedByType : Application +Tag : { + } +TotalCpuMHz : +TotalMemoryGb : +Type : microsoft.connectedvmwarevsphere/clusters +UsedCpuMHz : +UsedMemoryGb : +Uuid : dd163232-210f-4f82-8b0c-9866a2eac862 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc +``` + +This command gets a Cluster named `test-cluster` in a resource group named `test-rg`. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -95,39 +141,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -156,13 +171,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -171,36 +186,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -226,7 +211,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -237,30 +222,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.ICluster + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarecluster](https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarecluster) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareDatastore.md b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareDatastore.md index 509c0595f0e5..1cdde5b9ea54 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareDatastore.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareDatastore.md @@ -14,32 +14,26 @@ Implements datastore GET method. ### List (Default) ``` -Get-AzConnectedVMwareDatastore [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareDatastore [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzConnectedVMwareDatastore -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List1 ``` Get-AzConnectedVMwareDatastore -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzConnectedVMwareDatastore -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareDatastore -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -47,37 +41,85 @@ Implements datastore GET method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List Datastores in current subscription +```powershell Get-AzConnectedVMwareDatastore -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 2 +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-datastore1 test-rg1 + eastus test-datastore2 test-rg2 + eastus test-datastore3 test-rg3 + eastus test-datastore4 test-rg4 + eastus test-datastore5 test-rg5 + eastus test-datastore6 test-rg6 + eastus test-datastore7 test-rg7 + eastus test-datastore8 test-rg8 ``` + +This command lists Datastores in current subscription. + +### Example 2: List Datastores in a resource group +```powershell Get-AzConnectedVMwareDatastore -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 3 -``` -Get-AzConnectedVMwareDatastore -Name "test-datastore" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-datastore1 test-rg + eastus test-datastore2 test-rg ``` -## PARAMETERS +This command lists Datastores in a resource group named `test-rg`. -### -Break -Wait for .NET debugger to attach +### Example 3: Get a specific Datastore +```powershell +Get-AzConnectedVMwareDatastore -Name "test-datastore" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +```output +CapacityGb : 439 +CustomResourceName : 178ef312-fb33-4a85-b513-d9d7f7f5034b +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +FreeSpaceGb : 408 +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Datastores/test-datastore +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/datastore-713967 +Kind : +Location : eastus +MoName : datastore +MoRefId : datastore-713967 +Name : datastore +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-07-12T09:54:19.7224005Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-07-12T09:54:19.7224005Z" + }} +SystemDataCreatedAt : 7/12/2023 9:53:52 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/12/2023 9:53:52 AM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + } +Type : microsoft.connectedvmwarevsphere/datastores +Uuid : 178ef312-fb33-4a85-b513-d9d7f7f5034b +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` + +This command gets a Datastore named `test-datastore` in a resource group named `test-rg`. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -95,39 +137,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -156,13 +167,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -171,36 +182,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -226,7 +207,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -237,30 +218,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IDatastore + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwaredatastore](https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwaredatastore) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareHost.md b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareHost.md index 11e169e55f95..21e2af527459 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareHost.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareHost.md @@ -14,31 +14,26 @@ Implements host GET method. ### List (Default) ``` -Get-AzConnectedVMwareHost [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareHost [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzConnectedVMwareHost -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List1 ``` Get-AzConnectedVMwareHost -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzConnectedVMwareHost -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareHost -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -46,37 +41,89 @@ Implements host GET method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List Hosts in current subscription +```powershell Get-AzConnectedVMwareHost -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 2 +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-host1 test-rg1 + eastus test-host2 test-rg2 + eastus test-host3 test-rg3 + eastus test-host4 test-rg4 + eastus test-host5 test-rg5 + eastus test-host6 test-rg6 + eastus test-host7 test-rg7 + eastus test-host8 test-rg8 ``` + +This command lists Hosts in current subscription. + +### Example 2: List Hosts in a resource group +```powershell Get-AzConnectedVMwareHost -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 3 -``` -Get-AzConnectedVMwareHost -Name "test-host" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-host1 test-rg + eastus test-host2 test-rg ``` -## PARAMETERS +This command lists Hosts in a resource group named `test-rg`. -### -Break -Wait for .NET debugger to attach +### Example 3: Get a specific Host +```powershell +Get-AzConnectedVMwareHost -Name "test-host" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +```output +CpuMhz : 105312 +CustomResourceName : 030afcea-3fa5-4e65-bf26-84e8d1c4e230 +DatastoreId : {} +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : customLocation +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Hosts/test-host +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/host-1147412 +Kind : +Location : eastus +MemorySizeGb : 127 +MoName : 1.2.3.4 +MoRefId : host-1147412 +Name : test-host +NetworkId : {/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VirtualNetworks/test-vnet-tf} +OverallCpuUsageMHz : 20236 +OverallMemoryUsageGb : 118 +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-05T06:05:59.8990231Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-05T06:05:59.8990231Z" + }} +SystemDataCreatedAt : 10/5/2023 6:05:41 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/5/2023 6:59:56 AM +SystemDataLastModifiedBy : ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 +SystemDataLastModifiedByType : Application +Tag : { + } +Type : microsoft.connectedvmwarevsphere/hosts +Uuid : 030afcea-3fa5-4e65-bf26-84e8d1c4e230 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg2/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` + +This command gets a Host named `test-host` in a resource group named `test-rg`. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -94,39 +141,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -155,13 +171,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -170,36 +186,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -225,7 +211,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -236,30 +222,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IHost + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarehost](https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarehost) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareInventoryItem.md b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareInventoryItem.md index eb4f3e144df9..24c6f251ba95 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareInventoryItem.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareInventoryItem.md @@ -15,32 +15,25 @@ Implements InventoryItem GET method. ### List (Default) ``` Get-AzConnectedVMwareInventoryItem -ResourceGroupName [-SubscriptionId ] - -VcenterName [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + -VcenterName [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentityVcenter ``` Get-AzConnectedVMwareInventoryItem -Name -VcenterInputObject - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzConnectedVMwareInventoryItem -Name -ResourceGroupName [-SubscriptionId ] - -VcenterName [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + -VcenterName [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` Get-AzConnectedVMwareInventoryItem -InputObject [-DefaultProfile ] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -48,32 +41,62 @@ Implements InventoryItem GET method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List Inventory Items in a resource group of a vcenter +```powershell Get-AzConnectedVMwareInventoryItem -ResourceGroupName "test-rg" -VcenterName "test-vc" ``` -### EXAMPLE 2 -``` -Get-AzConnectedVMwareInventoryItem -Name "vm-1528708" -VcenterName "test-vc" -ResourceGroupName "test-rg" +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Kind ResourceGroupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- ----------------- +resgroup-713957 2/16/2023 3:54:14 PM ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 Application 8/1/2023 5:27:42 AM ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 Application ResourcePool test-rg +resgroup-754929 2/16/2023 3:54:14 PM ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 Application 8/1/2023 5:27:44 AM ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 Application ResourcePool test-rg +dvportgroup-1153526 2/16/2023 3:54:17 PM ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 Application 8/1/2023 5:26:11 AM ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 Application VirtualNetwork test-rg +host-713958 2/16/2023 3:54:17 PM ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 Application 8/1/2023 5:26:32 AM ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 Application Host test-rg +vmtpl-vm-1085854 2/16/2023 3:54:17 PM ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 Application 8/1/2023 5:29:46 AM ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 Application VirtualMachineTemplate test-rg +datastore-563660 2/16/2023 3:54:17 PM ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 Application 10/5/2023 5:15:03 PM ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 Application Datastore test-rg ``` -## PARAMETERS +This command list all the inventory items of vcenter `test-vc` in a resource group named `test-rg`. -### -Break -Wait for .NET debugger to attach +### Example 2: Get a specific Inventory Item +```powershell +Get-AzConnectedVMwareInventoryItem -Name "vm-1528708" -VcenterName "test-vc" -ResourceGroupName "test-rg" +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +```output +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/vm-1528708 +InventoryType : VirtualMachine +Kind : VirtualMachine +ManagedResourceId : +MoName : ArcVMwareTest-VM-e976dc7c +MoRefId : vm-1528708 +Name : vm-1528708 +Property : { + "inventoryType": "VirtualMachine", + "managedResourceId": "", + "moRefId": "vm-1528708", + "moName": "ArcVMwareTest-VM-e976dc7c", + "provisioningState": "Succeeded", + "osType": "Other", + "ipAddresses": [ ], + "folderPath": "ArcPrivateClouds-67", + "powerState": "poweredOff" + } +ProvisioningState : Succeeded +ResourceGroupName : test-rg +SystemDataCreatedAt : 10/5/2023 7:16:13 PM +SystemDataCreatedBy : ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 10/5/2023 7:16:13 PM +SystemDataLastModifiedBy : ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 +SystemDataLastModifiedByType : Application +Type : microsoft.connectedvmwarevsphere/vcenters/inventoryitems +``` + +This command gets a Inventory Item named `vm-1528708` in a resource group named `test-rg`. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -91,39 +114,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -152,28 +144,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -182,21 +159,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -222,14 +184,13 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` ### -VcenterInputObject Identity Parameter -To construct, see NOTES section for VCENTERINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -264,44 +225,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IInventoryItem + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. - -VCENTERINPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwareinventoryitem](https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwareinventoryitem) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareResourcePool.md b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareResourcePool.md index 2f714f08030a..191490b0a15d 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareResourcePool.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareResourcePool.md @@ -14,32 +14,26 @@ Implements resourcePool GET method. ### List (Default) ``` -Get-AzConnectedVMwareResourcePool [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareResourcePool [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzConnectedVMwareResourcePool -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List1 ``` Get-AzConnectedVMwareResourcePool -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzConnectedVMwareResourcePool -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareResourcePool -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -47,37 +41,97 @@ Implements resourcePool GET method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List Resource Pools in current subscription +```powershell Get-AzConnectedVMwareResourcePool -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 2 +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-rp1 test-rg1 + eastus test-rp2 test-rg2 + eastus test-rp3 test-rg3 + eastus test-rp4 test-rg4 + eastus test-rp5 test-rg5 + eastus test-rp6 test-rg6 + eastus test-rp7 test-rg7 + eastus test-rp8 test-rg8 ``` + +This command lists Resource Pools in current subscription. + +### Example 2: List Resource Pools in a resource group +```powershell Get-AzConnectedVMwareResourcePool -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 3 -``` -Get-AzConnectedVMwareResourcePool -Name "test-rp" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-rp1 test-rg + eastus test-rp2 test-rg ``` -## PARAMETERS +This command lists Resource Pools in a resource group named `test-rg`. -### -Break -Wait for .NET debugger to attach +### Example 3: Get a specific Resource Pool +```powershell +Get-AzConnectedVMwareResourcePool -Name "test-rp" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +```output +CpuCapacityMHz : 197132 +CpuLimitMHz : -1 +CpuOverallUsageMHz : 105 +CpuReservationMHz : +CpuSharesLevel : normal +CustomResourceName : c0d495b2-ff38-4131-ab85-061bc3b1700a +DatastoreId : {/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Datastores/test-ds1, + /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Datastores/test-ds2, + /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Datastores/test-ds3 +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/ResourcePools/subbart +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/resgroup-1045861 +Kind : +Location : westus3 +MemCapacityGb : 342 +MemLimitMb : -1 +MemOverallUsageGb : 5 +MemReservationMb : +MemSharesLevel : normal +MoName : subbart +MoRefId : resgroup-1045861 +Name : subbart +NetworkId : {} +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-07-27T05:57:35.4692495Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-07-27T05:57:35.4692495Z" + }} +SystemDataCreatedAt : 7/27/2023 5:56:46 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/18/2023 4:35:27 AM +SystemDataLastModifiedBy : ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 +SystemDataLastModifiedByType : Application +Tag : { + } +Type : microsoft.connectedvmwarevsphere/resourcepools +Uuid : c0d495b2-ff38-4131-ab85-061bc3b1700a +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` + +This command gets a Resource Pool named `test-rp` in a resource group named `test-rg`. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -95,39 +149,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -156,13 +179,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -171,36 +194,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -226,7 +219,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -237,30 +230,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IResourcePool + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwareresourcepool](https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwareresourcepool) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVCenter.md b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVCenter.md index 1be4b7eeb4cf..a8c6350ff966 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVCenter.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVCenter.md @@ -14,32 +14,26 @@ Implements vCenter GET method. ### List (Default) ``` -Get-AzConnectedVMwareVCenter [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareVCenter [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzConnectedVMwareVCenter -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List1 ``` Get-AzConnectedVMwareVCenter -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzConnectedVMwareVCenter -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareVCenter -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -47,37 +41,90 @@ Implements vCenter GET method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List VCenters in current subscription +```powershell Get-AzConnectedVMwareVCenter -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 2 +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- +VMware eastus test-vc1 test-rg1 +VMware eastus test-vc2 test-rg2 +VMware eastus test-vc3 test-rg3 +VMware eastus test-vc4 test-rg4 +VMware eastus test-vc5 test-rg5 +AVS eastus test-vc6 test-rg6 +VMware eastus test-vc7 test-rg7 +VMware EastUS test-vc8 test-rg8 ``` + +This command lists VCenters in current subscription. + +### Example 2: List VCenters in a resource group +```powershell Get-AzConnectedVMwareVCenter -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 3 -``` -Get-AzConnectedVMwareVCenter -Name "test-vc" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-vc1 test-rg + eastus test-vc2 test-rg ``` -## PARAMETERS +This command lists VCenters in a resource group named `test-rg`. -### -Break -Wait for .NET debugger to attach +### Example 3: Get a specific VCenter +```powershell +Get-AzConnectedVMwareVCenter -Name "test-vc" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +```output +ConnectionStatus : Connected +CredentialsPassword : +CredentialsUsername : arcvmware +CustomResourceName : e6048b2a-ba86-4334-adff-ba3d617d12ef +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Fqdn : 1.2.3.4 +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc +InstanceUuid : db73f8f2-624c-4a0f-905b-8c6f34442cbc +Kind : VMware +Location : eastus +Name : test-vc +Port : 443 +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Connected", + "status": "True", + "lastUpdatedAt": "2023-09-18T08:04:35.0000000Z" + }, { + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-08-01T05:26:07.8798425Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-08-01T05:26:07.8798425Z" + }} +SystemDataCreatedAt : 2/16/2023 3:53:39 PM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/18/2023 8:04:40 AM +SystemDataLastModifiedBy : ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 +SystemDataLastModifiedByType : Application +Tag : { + } +Type : microsoft.connectedvmwarevsphere/vcenters +Uuid : e6048b2a-ba86-4334-adff-ba3d617d12ef +Version : 6.7.0 +``` + +This command gets a VCenter named `test-vc` in a resource group named `test-rg`. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -95,39 +142,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -156,13 +172,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -171,36 +187,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -226,7 +212,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -237,30 +223,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVCenter + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarevcenter](https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarevcenter) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVM.md b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVM.md index 9a113055d30c..7626f36602e7 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVM.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVM.md @@ -13,9 +13,8 @@ Retrieves information about a virtual machine instance. ## SYNTAX ``` -Get-AzConnectedVMwareVM -MachineId [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareVM -MachineId [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -23,27 +22,107 @@ Retrieves information about a virtual machine instance. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Get a specific VM +```powershell Get-AzConnectedVMwareVM -MachineId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine" ``` -## PARAMETERS - -### -Break -Wait for .NET debugger to attach +```output +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +HardwareProfileCpuHotAddEnabled : True +HardwareProfileCpuHotRemoveEnabled : False +HardwareProfileMemoryHotAddEnabled : True +HardwareProfileMemorySizeMb : 1024 +HardwareProfileNumCoresPerSocket : 1 +HardwareProfileNumCpus : 1 +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineInstances/default +InfrastructureProfileCustomResourceName : d04a3534-2dfa-42c8-8959-83796a1bcac1 +InfrastructureProfileFirmwareType : bios +InfrastructureProfileFolderPath : ArcPrivateClouds-67 +InfrastructureProfileInstanceUuid : d04a3534-2dfa-42c8-8959-83796a1bcac1 +InfrastructureProfileInventoryItemId : +InfrastructureProfileMoName : test-machine +InfrastructureProfileMoRefId : vm-1529269 +InfrastructureProfileSmbiosUuid : 4215b305-5f69-959b-0620-16a5bd8c5fc9 +InfrastructureProfileTemplateId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/test-tmpl +InfrastructureProfileVCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc +Name : default +NetworkProfileNetworkInterface : {{ + "ipSettings": { + "allocationMethod": "unset" + }, + "name": "nic_1", + "label": "Network adapter 1", + "ipAddresses": [ "10.150.176.100", "fe80::250:56ff:fe95:ecbc", "2404:f801:4800:14:250:56ff:fe95:ecbc" ], + "macAddress": "00:50:56:95:ec:bc", + "networkId": "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VirtualNetworks/test-vnet", + "nicType": "vmxnet3", + "powerOnBoot": "enabled", + "networkMoRefId": "network-563661", + "networkMoName": "VM Network", + "deviceKey": 4000 + }} +OSProfileAdminPassword : +OSProfileAdminUsername : +OSProfileComputerName : test-machine +OSProfileGuestId : ubuntu64Guest +OSProfileOssku : Ubuntu Linux (64-bit) +OSProfileOstype : Linux +OSProfileToolsRunningStatus : guestToolsRunning +OSProfileToolsVersion : 10304 +OSProfileToolsVersionStatus : guestToolsUnmanaged +PlacementProfileClusterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Clusters/test-cluster +PlacementProfileDatastoreId : +PlacementProfileHostId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Hosts/test-host +PlacementProfileResourcePoolId : +PowerState : poweredOn +ProvisioningState : Succeeded +ResourceGroupName : test-rg +ResourceUid : 4c9c3021-d32e-48f9-b8ac-9cb14ebf6d75 +Statuses : {{ + "type": "CustomizationCompleted", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:36.0000000Z" + }, { + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:45.2429702Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:45.2429702Z" + }} +StorageProfileDisk : {{ + "name": "disk_1", + "label": "Hard disk 1", + "diskObjectId": "7435-2000", + "diskSizeGB": 10, + "deviceKey": 2000, + "diskMode": "persistent", + "controllerKey": 1000, + "unitNumber": 0, + "diskType": "flat" + }} +StorageProfileScsiController : {{ + "type": "lsilogic", + "controllerKey": 1000, + "scsiCtlrUnitNumber": 7, + "sharing": "noSharing" + }} +SystemDataCreatedAt : 10/6/2023 12:28:17 PM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 12:48:40 PM +SystemDataLastModifiedBy : ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 +SystemDataLastModifiedByType : Application +Type : microsoft.connectedvmwarevsphere/virtualmachineinstances +UefiSettingSecureBootEnabled : False +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +This command gets a VM Instances of machine names `test-machine` -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -61,36 +140,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -MachineId The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. @@ -106,28 +155,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -136,21 +170,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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). @@ -159,9 +178,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVirtualMachineInstance + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarevm](https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarevm) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVMGuestAgent.md b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVMGuestAgent.md index 605bc5bd3bcb..f3a09220d792 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVMGuestAgent.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVMGuestAgent.md @@ -13,9 +13,8 @@ Implements GuestAgent GET method. ## SYNTAX ``` -Get-AzConnectedVMwareVMGuestAgent -MachineId [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareVMGuestAgent -MachineId [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -23,27 +22,45 @@ Implements GuestAgent GET method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Get guest agent of a specific VM +```powershell Get-AzConnectedVMwareVMGuestAgent -MachineId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine" ``` -## PARAMETERS - -### -Break -Wait for .NET debugger to attach +```output +CredentialsPassword : +CredentialsUsername : abc +CustomResourceName : d04a3534-2dfa-42c8-8959-83796a1bcac1 +HttpProxyConfigHttpsProxy : +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineInstances/default/guestAgents/default +Name : default +PrivateLinkScopeResourceId : +ProvisioningAction : install +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Status : Enabled +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T14:47:02.1828535Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T14:47:02.1828535Z" + }} +SystemDataCreatedAt : 10/6/2023 2:45:33 PM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 2:45:33 PM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Type : microsoft.connectedvmwarevsphere/virtualmachineinstances/guestagents +Uuid : 6a37a700-e02c-476d-a19f-258761575c40 +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +This command gets a guest agent of a VM Instances of machine named `test-machine`. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -61,36 +78,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -MachineId The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. @@ -106,28 +93,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -136,21 +108,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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). @@ -159,9 +116,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IGuestAgent + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarevmguestagent](https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarevmguestagent) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVMTemplate.md b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVMTemplate.md index 3fd2f75263a3..56de396018e4 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVMTemplate.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVMTemplate.md @@ -14,32 +14,26 @@ Implements virtual machine template GET method. ### List (Default) ``` -Get-AzConnectedVMwareVMTemplate [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareVMTemplate [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzConnectedVMwareVMTemplate -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List1 ``` Get-AzConnectedVMwareVMTemplate -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzConnectedVMwareVMTemplate -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareVMTemplate -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -47,37 +41,116 @@ Implements virtual machine template GET method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List VM Templates in current subscription +```powershell Get-AzConnectedVMwareVMTemplate -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 2 +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-vmtmpl1 test-rg1 + eastus test-vmtmpl2 test-rg2 + eastus test-vmtmpl3 test-rg3 + eastus test-vmtmpl4 test-rg4 + eastus test-vmtmpl5 test-rg5 + eastus test-vmtmpl6 test-rg6 + eastus test-vmtmpl7 test-rg7 + eastus test-vmtmpl8 test-rg8 ``` + +This command lists VM Templates in current subscription. + +### Example 2: List VM Templates in a resource group +```powershell Get-AzConnectedVMwareVMTemplate -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 3 +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-vmtmpl1 test-rg + eastus test-vmtmpl2 test-rg ``` + +This command lists VM Templates in a resource group named `test-rg`. + +### Example 3: Get a specific VM Template +```powershell Get-AzConnectedVMwareVMTemplate -Name "test-vmtmpl" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -## PARAMETERS - -### -Break -Wait for .NET debugger to attach +```output +CustomResourceName : 6da8abd3-8857-4599-bd6f-831846bbdd0d +Disk : {{ + "name": "disk_1", + "label": "Hard disk 1", + "diskObjectId": "3-2000", + "diskSizeGB": 32, + "deviceKey": 2000, + "diskMode": "persistent", + "controllerKey": 1000, + "unitNumber": 0, + "diskType": "flat" + }} +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +FirmwareType : +FolderPath : ArcPrivateClouds-67/Templates +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VirtualMachineTemplates/azurearcvmwareubuntu20template +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/vmtpl-vm-651995 +Kind : +Location : westus3 +MemorySizeMb : 8192 +MoName : azurearcvmwareubuntu20template +MoRefId : vm-651995 +Name : azurearcvmwareubuntu20template +NetworkInterface : {{ + "ipSettings": { + "allocationMethod": "unset" + }, + "name": "nic_1", + "label": "Network adapter 1", + "macAddress": "00:50:56:95:a2:c6", + "nicType": "vmxnet3", + "powerOnBoot": "enabled", + "networkMoRefId": "network-563661", + "networkMoName": "VM Network", + "deviceKey": 4000 + }} +NumCoresPerSocket : 1 +NumCpUs : 4 +OSName : Ubuntu Linux (64-bit) +OSType : Linux +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-08-16T06:43:49.8483078Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-08-16T06:43:49.8483078Z" + }} +SystemDataCreatedAt : 8/16/2023 6:43:21 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/16/2023 6:43:21 AM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + } +ToolsVersion : 11333 +ToolsVersionStatus : guestToolsSupportedNew +Type : microsoft.connectedvmwarevsphere/virtualmachinetemplates +Uuid : 6da8abd3-8857-4599-bd6f-831846bbdd0d +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +This command gets a VM Template named `test-vmtmpl` in a resource group named `test-rg`. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -95,39 +168,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -156,13 +198,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -171,36 +213,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -226,7 +238,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -237,30 +249,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVirtualMachineTemplate + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarevmtemplate](https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarevmtemplate) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVNet.md b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVNet.md index dde452460083..08e0868999ce 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVNet.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareVNet.md @@ -14,31 +14,26 @@ Implements virtual network GET method. ### List (Default) ``` -Get-AzConnectedVMwareVNet [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareVNet [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzConnectedVMwareVNet -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List1 ``` Get-AzConnectedVMwareVNet -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzConnectedVMwareVNet -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzConnectedVMwareVNet -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -46,37 +41,83 @@ Implements virtual network GET method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List Virtual Networks in current subscription +```powershell Get-AzConnectedVMwareVNet -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 2 +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-vnet1 test-rg1 + eastus test-vnet2 test-rg2 + eastus test-vnet3 test-rg3 + eastus test-vnet4 test-rg4 + eastus test-vnet5 test-rg5 + eastus test-vnet6 test-rg6 + eastus test-vnet7 test-rg7 + eastus test-vnet8 test-rg8 ``` + +This command lists Virtual Networks in current subscription. + +### Example 2: List Virtual Networks in a resource group +```powershell Get-AzConnectedVMwareVNet -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` -### EXAMPLE 3 -``` -Get-AzConnectedVMwareVNet -Name "test-vnet" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" +```output +Kind Location Name ResourceGroupName +---- -------- ---- ----------------- + eastus test-vnet1 test-rg + eastus test-vnet2 test-rg ``` -## PARAMETERS +This command lists Virtual Networks in a resource group named `test-rg`. -### -Break -Wait for .NET debugger to attach +### Example 3: Get a specific Virtual Network +```powershell +Get-AzConnectedVMwareVNet -Name "test-vnet" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +```output +CustomResourceName : a8feca6f-9d35-411d-a594-33fd28043966 +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VirtualNetworks/VM-Network +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/network-563661 +Kind : +Location : australiaeast +MoName : VM Network +MoRefId : network-563661 +Name : VM-Network +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2022-06-30T07:00:45.0455281Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2022-06-30T07:00:45.0455281Z" + }} +SystemDataCreatedAt : 6/30/2022 7:00:07 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 6/30/2022 7:00:07 AM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + } +Type : microsoft.connectedvmwarevsphere/virtualnetworks +Uuid : a8feca6f-9d35-411d-a594-33fd28043966 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` + +This command gets a Virtual Network named `test-vnet` in a resource group named `test-rg`. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -94,39 +135,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -155,13 +165,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -170,36 +180,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -225,7 +205,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -236,30 +216,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVirtualNetwork + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarevnet](https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarevnet) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareCluster.md b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareCluster.md index cc08d87480ae..87588d330823 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareCluster.md +++ b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareCluster.md @@ -15,27 +15,23 @@ Create cluster. ### CreateExpanded (Default) ``` New-AzConnectedVMwareCluster -Name -ResourceGroupName [-SubscriptionId ] - -Location [-ExtendedLocationName ] [-ExtendedLocationType ] - [-InventoryItemId ] [-Kind ] [-MoRefId ] [-Tag ] [-VCenterId ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ExtendedLocationName ] [-ExtendedLocationType ] [-InventoryItemId ] [-Kind ] + [-Location ] [-MoRefId ] [-Tag ] [-VCenterId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzConnectedVMwareCluster -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzConnectedVMwareCluster -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -43,11 +39,54 @@ Create cluster. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create Cluster +```powershell New-AzConnectedVMwareCluster -Name "test-cluster" -ResourceGroupName "test-rg" -Location "eastus" -ExtendedLocationName "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl" -ExtendedLocationType "CustomLocation" -InventoryItemId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/domain-c649660" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +```output +CustomResourceName : 1040d770-249a-4b2c-b7f4-a2ed32b05f81 +DatastoreId : {} +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/clusters/test-cluster +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/domain-c649660 +Kind : +Location : eastus +MoName : Cluster1 +MoRefId : domain-c649660 +Name : test-cluster +NetworkId : {} +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:45:36.1775643Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:45:36.1775643Z" + }} +SystemDataCreatedAt : 10/6/2023 10:45:17 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 10:45:17 AM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + } +TotalCpuMHz : 210624 +TotalMemoryGb : 383 +Type : microsoft.connectedvmwarevsphere/clusters +UsedCpuMHz : 50475 +UsedMemoryGb : 367989 +Uuid : 1040d770-249a-4b2c-b7f4-a2ed32b05f81 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` + +This command create a Cluster named `test-cluster` in a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -60,22 +99,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -126,36 +150,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InventoryItemId Gets or sets the inventory Item ID for the cluster. @@ -226,7 +220,7 @@ Type: System.String Parameter Sets: CreateExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -271,21 +265,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -293,13 +272,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -308,21 +287,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -348,7 +312,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -422,9 +386,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.ICluster + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarecluster](https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarecluster) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareDatastore.md b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareDatastore.md index 436f9fee9b72..a402f751c9d7 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareDatastore.md +++ b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareDatastore.md @@ -15,27 +15,23 @@ Create datastore. ### CreateExpanded (Default) ``` New-AzConnectedVMwareDatastore -Name -ResourceGroupName [-SubscriptionId ] - -Location [-ExtendedLocationName ] [-ExtendedLocationType ] - [-InventoryItemId ] [-Kind ] [-MoRefId ] [-Tag ] [-VCenterId ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ExtendedLocationName ] [-ExtendedLocationType ] [-InventoryItemId ] [-Kind ] + [-Location ] [-MoRefId ] [-Tag ] [-VCenterId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzConnectedVMwareDatastore -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzConnectedVMwareDatastore -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -43,11 +39,50 @@ Create datastore. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create Datastore +```powershell New-AzConnectedVMwareDatastore -Name "test-datastore" -ResourceGroupName "test-rg" -Location "eastus" -ExtendedLocationName "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl" -ExtendedLocationType "CustomLocation" -InventoryItemId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/datastore-563660" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +```output +CapacityGb : 46079 +CustomResourceName : 9a2cb7ed-52a7-4fad-be88-6ff3794f80c7 +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +FreeSpaceGb : 13778 +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/datastores/test-datastore +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/datastore-563660 +Kind : +Location : eastus +MoName : Shared 15TB +MoRefId : datastore-563660 +Name : test-datastore +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:50:38.1524028Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:50:38.1524028Z" + }} +SystemDataCreatedAt : 10/6/2023 10:50:21 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 10:50:21 AM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + } +Type : microsoft.connectedvmwarevsphere/datastores +Uuid : 9a2cb7ed-52a7-4fad-be88-6ff3794f80c7 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` + +This command create a Datastore named `test-datastore` in a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -60,22 +95,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -126,36 +146,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InventoryItemId Gets or sets the inventory Item ID for the datastore. @@ -226,7 +216,7 @@ Type: System.String Parameter Sets: CreateExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -271,21 +261,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -293,13 +268,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -308,21 +283,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -348,7 +308,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -422,9 +382,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IDatastore + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwaredatastore](https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwaredatastore) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareHost.md b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareHost.md index 78d4d5e04095..8ae3e5f74bfd 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareHost.md +++ b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareHost.md @@ -15,27 +15,23 @@ Create host. ### CreateExpanded (Default) ``` New-AzConnectedVMwareHost -Name -ResourceGroupName [-SubscriptionId ] - -Location [-ExtendedLocationName ] [-ExtendedLocationType ] - [-InventoryItemId ] [-Kind ] [-MoRefId ] [-Tag ] [-VCenterId ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ExtendedLocationName ] [-ExtendedLocationType ] [-InventoryItemId ] [-Kind ] + [-Location ] [-MoRefId ] [-Tag ] [-VCenterId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzConnectedVMwareHost -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzConnectedVMwareHost -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -43,11 +39,54 @@ Create host. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create Host +```powershell New-AzConnectedVMwareHost -Name "test-host" -ResourceGroupName "test-rg" -Location "eastus" -ExtendedLocationName "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl" -ExtendedLocationType "CustomLocation" -InventoryItemId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/host-1147412" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +```output +CpuMhz : 2194 +CustomResourceName : 6d40fd86-6f29-44ed-8e3a-fa7a11b5f1ac +DatastoreId : {/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Datastores/test-datastore} +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/hosts/test-host +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/host-1147412 +Kind : +Location : eastus +MemorySizeGb : 127 +MoName : 10.150.178.208 +MoRefId : host-1147412 +Name : test-host +NetworkId : {} +OverallCpuUsageMHz : 17969 +OverallMemoryUsageGb : 118 +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:54:23.2077585Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:54:23.2077585Z" + }} +SystemDataCreatedAt : 10/6/2023 10:54:13 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 10:54:13 AM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + } +Type : microsoft.connectedvmwarevsphere/hosts +Uuid : 6d40fd86-6f29-44ed-8e3a-fa7a11b5f1ac +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` + +This command create a Host named `test-host` in a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -60,22 +99,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -126,36 +150,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InventoryItemId Gets or sets the inventory Item ID for the host. @@ -226,7 +220,7 @@ Type: System.String Parameter Sets: CreateExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -271,21 +265,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -293,13 +272,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -308,21 +287,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -348,7 +312,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -422,9 +386,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IHost + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarehost](https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarehost) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareResourcePool.md b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareResourcePool.md index 6183fef8c9c5..5b0c4a6303ff 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareResourcePool.md +++ b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareResourcePool.md @@ -15,27 +15,23 @@ Create resourcePool. ### CreateExpanded (Default) ``` New-AzConnectedVMwareResourcePool -Name -ResourceGroupName [-SubscriptionId ] - -Location [-ExtendedLocationName ] [-ExtendedLocationType ] - [-InventoryItemId ] [-Kind ] [-MoRefId ] [-Tag ] [-VCenterId ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ExtendedLocationName ] [-ExtendedLocationType ] [-InventoryItemId ] [-Kind ] + [-Location ] [-MoRefId ] [-Tag ] [-VCenterId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzConnectedVMwareResourcePool -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzConnectedVMwareResourcePool -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -43,11 +39,60 @@ Create resourcePool. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create Resource Pool +```powershell New-AzConnectedVMwareResourcePool -Name "test-rp" -ResourceGroupName "test-rg" -Location "eastus" -ExtendedLocationName "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl" -ExtendedLocationType "CustomLocation" -InventoryItemId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/resgroup-724471" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +```output +CpuCapacityMHz : 197132 +CpuLimitMHz : -1 +CpuOverallUsageMHz : 964 +CpuReservationMHz : +CpuSharesLevel : normal +CustomResourceName : e296ddc2-ab72-4bba-9bf9-9fb18abaabf7 +DatastoreId : {/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Datastores/test-datastore} +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/resourcePools/test-rp +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/resgroup-724471 +Kind : +Location : eastus +MemCapacityGb : 344 +MemLimitMb : -1 +MemOverallUsageGb : 11 +MemReservationMb : +MemSharesLevel : normal +MoName : test-rp +MoRefId : resgroup-724471 +Name : test-rp +NetworkId : {} +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:58:30.1697443Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:58:30.1697443Z" + }} +SystemDataCreatedAt : 10/6/2023 10:58:11 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 10:58:11 AM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + } +Type : microsoft.connectedvmwarevsphere/resourcepools +Uuid : e296ddc2-ab72-4bba-9bf9-9fb18abaabf7 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` + +This command create a Resource Pool named `test-rp` in a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -60,22 +105,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -126,36 +156,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InventoryItemId Gets or sets the inventory Item ID for the resource pool. @@ -226,7 +226,7 @@ Type: System.String Parameter Sets: CreateExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -271,21 +271,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -293,13 +278,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -308,21 +293,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -348,7 +318,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -422,9 +392,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IResourcePool + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwareresourcepool](https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwareresourcepool) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVCenter.md b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVCenter.md index 73274d4a6d8a..bfea09c604c5 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVCenter.md +++ b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVCenter.md @@ -15,27 +15,24 @@ Create vCenter. ### CreateExpanded (Default) ``` New-AzConnectedVMwareVCenter -Name -ResourceGroupName [-SubscriptionId ] - -Fqdn -Location [-CredentialsPassword ] [-CredentialsUsername ] - [-ExtendedLocationName ] [-ExtendedLocationType ] [-Kind ] [-Port ] - [-Tag ] [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-CredentialsPassword ] [-CredentialsUsername ] [-ExtendedLocationName ] + [-ExtendedLocationType ] [-Fqdn ] [-Kind ] [-Location ] [-Port ] + [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzConnectedVMwareVCenter -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzConnectedVMwareVCenter -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -43,11 +40,55 @@ Create vCenter. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create VCenter +```powershell New-AzConnectedVMwareVCenter -Name "test-vc" -Fqdn "1.2.3.4" -CredentialsUsername "test-user" -CredentialsPassword "test-pw" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" -Location "eastus" -ExtendedLocationName "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl" -ExtendedLocationType "CustomLocation" ``` +```output +ConnectionStatus : Connected +CredentialsPassword : +CredentialsUsername : abc +CustomResourceName : e6048b2a-ba86-4334-adff-ba3d617d12ef +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Fqdn : 1.2.3.4 +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc +InstanceUuid : db73f8f2-624c-4a0f-905b-8c6f34442cbc +Kind : VMware +Location : eastus +Name : test-vc +Port : 443 +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Connected", + "status": "True", + "lastUpdatedAt": "2023-09-18T08:04:35.0000000Z" + }, { + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-08-01T05:26:07.8798425Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-08-01T05:26:07.8798425Z" + }} +SystemDataCreatedAt : 2/16/2023 3:53:39 PM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/18/2023 8:04:40 AM +SystemDataLastModifiedBy : ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 +SystemDataLastModifiedByType : Application +Tag : { + } +Type : microsoft.connectedvmwarevsphere/vcenters +Uuid : e6048b2a-ba86-4334-adff-ba3d617d12ef +Version : 6.7.0 +``` + +This command create a VCenter named `test-vc` in a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -60,22 +101,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -164,36 +190,6 @@ Type: System.String Parameter Sets: CreateExpanded Aliases: -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -256,7 +252,7 @@ Type: System.String Parameter Sets: CreateExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -288,7 +284,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -301,21 +297,6 @@ Type: System.Int32 Parameter Sets: CreateExpanded Aliases: -Required: False -Position: Named -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -323,13 +304,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -338,21 +319,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -378,7 +344,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -437,9 +403,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVCenter + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarevcenter](https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarevcenter) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVM.md b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVM.md index ef23bba23812..817d21f7ca32 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVM.md +++ b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVM.md @@ -25,24 +25,19 @@ New-AzConnectedVMwareVM -MachineId [-ExtendedLocationName ] [-E [-OSProfileOstype ] [-PlacementProfileClusterId ] [-PlacementProfileDatastoreId ] [-PlacementProfileHostId ] [-PlacementProfileResourcePoolId ] [-StorageProfileDisk ] [-UefiSettingSecureBootEnabled] [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzConnectedVMwareVM -MachineId -JsonFilePath [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` -New-AzConnectedVMwareVM -MachineId -JsonString [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +New-AzConnectedVMwareVM -MachineId -JsonString [-DefaultProfile ] [-AsJob] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -51,26 +46,418 @@ Please note some properties can be set only during virtual machine instance crea ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create Virtual Machine Instances on the given Resource Pool +```powershell New-AzConnectedVMwareVM -ExtendedLocationName "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl" -ExtendedLocationType "CustomLocation" -InfrastructureProfileTemplateId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/test-vmtmpl" -InfrastructureProfileVCenterId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc" -PlacementProfileResourcePoolId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/resourcepools/test-rp" -MachineId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine" ``` -### EXAMPLE 2 -``` +```output +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +HardwareProfileCpuHotAddEnabled : True +HardwareProfileCpuHotRemoveEnabled : False +HardwareProfileMemoryHotAddEnabled : True +HardwareProfileMemorySizeMb : 1024 +HardwareProfileNumCoresPerSocket : 1 +HardwareProfileNumCpUs : 1 +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineInstances/default +InfrastructureProfileCustomResourceName : d04a3534-2dfa-42c8-8959-83796a1bcac1 +InfrastructureProfileFirmwareType : bios +InfrastructureProfileFolderPath : ArcPrivateClouds-67 +InfrastructureProfileInstanceUuid : d04a3534-2dfa-42c8-8959-83796a1bcac1 +InfrastructureProfileInventoryItemId : +InfrastructureProfileMoName : test-machine +InfrastructureProfileMoRefId : vm-1529269 +InfrastructureProfileSmbiosUuid : 4215b305-5f69-959b-0620-16a5bd8c5fc9 +InfrastructureProfileTemplateId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/test-vmtmpl +InfrastructureProfileVCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc +Name : default +NetworkProfileNetworkInterface : {{ + "ipSettings": { + "allocationMethod": "unset" + }, + "name": "nic_1", + "label": "Network adapter 1", + "macAddress": "00:50:56:95:ec:bc", + "networkId": "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VirtualNetworks/test-vnet", + "nicType": "vmxnet3", + "powerOnBoot": "enabled", + "networkMoRefId": "network-563661", + "networkMoName": "VM Network", + "deviceKey": 4000 + }} +OSProfileAdminPassword : +OSProfileAdminUsername : +OSProfileComputerName : +OSProfileGuestId : ubuntu64Guest +OSProfileOssku : Ubuntu Linux (64-bit) +OSProfileOstype : Linux +OSProfileToolsRunningStatus : guestToolsNotRunning +OSProfileToolsVersion : 10304 +OSProfileToolsVersionStatus : guestToolsUnmanaged +PlacementProfileClusterId : +PlacementProfileDatastoreId : +PlacementProfileHostId : +PlacementProfileResourcePoolId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/ResourcePools/test-rp +PowerState : poweredOn +ProvisioningState : Succeeded +ResourceGroupName : test-rg +ResourceUid : 4c9c3021-d32e-48f9-b8ac-9cb14ebf6d75 +Statuses : {{ + "type": "CustomizationCompleted", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:36.0000000Z" + }, { + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:45.2429702Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:45.2429702Z" + }} +StorageProfileDisk : {{ + "name": "disk_1", + "label": "Hard disk 1", + "diskObjectId": "7435-2000", + "diskSizeGB": 10, + "deviceKey": 2000, + "diskMode": "persistent", + "controllerKey": 1000, + "unitNumber": 0, + "diskType": "flat" + }} +StorageProfileScsiController : {{ + "type": "lsilogic", + "controllerKey": 1000, + "scsiCtlrUnitNumber": 7, + "sharing": "noSharing" + }} +SystemDataCreatedAt : 10/6/2023 12:28:17 PM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 12:28:17 PM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Type : microsoft.connectedvmwarevsphere/virtualmachineinstances +UefiSettingSecureBootEnabled : False +``` + +This command create a VM Instances of machine named `test-machine` in a resource group named `test-rg`. + +### Example 2: Create Virtual Machine Instances on the given Cluster +```powershell New-AzConnectedVMwareVM -ExtendedLocationName "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl" -ExtendedLocationType "CustomLocation" -InfrastructureProfileTemplateId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/test-vmtmpl" -InfrastructureProfileVCenterId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc" -PlacementProfileClusterId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/clusters/test-cluster" -MachineId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine" ``` -### EXAMPLE 3 -``` +```output +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +HardwareProfileCpuHotAddEnabled : True +HardwareProfileCpuHotRemoveEnabled : False +HardwareProfileMemoryHotAddEnabled : True +HardwareProfileMemorySizeMb : 1024 +HardwareProfileNumCoresPerSocket : 1 +HardwareProfileNumCpUs : 1 +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineInstances/default +InfrastructureProfileCustomResourceName : d04a3534-2dfa-42c8-8959-83796a1bcac1 +InfrastructureProfileFirmwareType : bios +InfrastructureProfileFolderPath : ArcPrivateClouds-67 +InfrastructureProfileInstanceUuid : d04a3534-2dfa-42c8-8959-83796a1bcac1 +InfrastructureProfileInventoryItemId : +InfrastructureProfileMoName : test-machine +InfrastructureProfileMoRefId : vm-1529269 +InfrastructureProfileSmbiosUuid : 4215b305-5f69-959b-0620-16a5bd8c5fc9 +InfrastructureProfileTemplateId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/test-vmtmpl +InfrastructureProfileVCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc +Name : default +NetworkProfileNetworkInterface : {{ + "ipSettings": { + "allocationMethod": "unset" + }, + "name": "nic_1", + "label": "Network adapter 1", + "macAddress": "00:50:56:95:ec:bc", + "networkId": "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VirtualNetworks/test-vnet", + "nicType": "vmxnet3", + "powerOnBoot": "enabled", + "networkMoRefId": "network-563661", + "networkMoName": "VM Network", + "deviceKey": 4000 + }} +OSProfileAdminPassword : +OSProfileAdminUsername : +OSProfileComputerName : +OSProfileGuestId : ubuntu64Guest +OSProfileOssku : Ubuntu Linux (64-bit) +OSProfileOstype : Linux +OSProfileToolsRunningStatus : guestToolsNotRunning +OSProfileToolsVersion : 10304 +OSProfileToolsVersionStatus : guestToolsUnmanaged +PlacementProfileClusterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Clusters/test-cluster +PlacementProfileDatastoreId : +PlacementProfileHostId : +PlacementProfileResourcePoolId : +PowerState : poweredOn +ProvisioningState : Succeeded +ResourceGroupName : test-rg +ResourceUid : 4c9c3021-d32e-48f9-b8ac-9cb14ebf6d75 +Statuses : {{ + "type": "CustomizationCompleted", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:36.0000000Z" + }, { + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:45.2429702Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:45.2429702Z" + }} +StorageProfileDisk : {{ + "name": "disk_1", + "label": "Hard disk 1", + "diskObjectId": "7435-2000", + "diskSizeGB": 10, + "deviceKey": 2000, + "diskMode": "persistent", + "controllerKey": 1000, + "unitNumber": 0, + "diskType": "flat" + }} +StorageProfileScsiController : {{ + "type": "lsilogic", + "controllerKey": 1000, + "scsiCtlrUnitNumber": 7, + "sharing": "noSharing" + }} +SystemDataCreatedAt : 10/6/2023 12:28:17 PM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 12:28:17 PM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Type : microsoft.connectedvmwarevsphere/virtualmachineinstances +UefiSettingSecureBootEnabled : False +``` + +This command create a VM Instances of machine named `test-machine` in a resource group named `test-rg`. + +### Example 3: Create Virtual Machine on the given Host +```powershell New-AzConnectedVMwareVM -ExtendedLocationName "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl" -ExtendedLocationType "CustomLocation" -InfrastructureProfileTemplateId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/test-vmtmpl" -InfrastructureProfileVCenterId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc" -PlacementProfileHostId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/hosts/test-host" -MachineId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine" ``` -### EXAMPLE 4 -``` +```output +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +HardwareProfileCpuHotAddEnabled : True +HardwareProfileCpuHotRemoveEnabled : False +HardwareProfileMemoryHotAddEnabled : True +HardwareProfileMemorySizeMb : 1024 +HardwareProfileNumCoresPerSocket : 1 +HardwareProfileNumCpUs : 1 +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineInstances/default +InfrastructureProfileCustomResourceName : d04a3534-2dfa-42c8-8959-83796a1bcac1 +InfrastructureProfileFirmwareType : bios +InfrastructureProfileFolderPath : ArcPrivateClouds-67 +InfrastructureProfileInstanceUuid : d04a3534-2dfa-42c8-8959-83796a1bcac1 +InfrastructureProfileInventoryItemId : +InfrastructureProfileMoName : test-machine +InfrastructureProfileMoRefId : vm-1529269 +InfrastructureProfileSmbiosUuid : 4215b305-5f69-959b-0620-16a5bd8c5fc9 +InfrastructureProfileTemplateId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/test-vmtmpl +InfrastructureProfileVCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc +Name : default +NetworkProfileNetworkInterface : {{ + "ipSettings": { + "allocationMethod": "unset" + }, + "name": "nic_1", + "label": "Network adapter 1", + "macAddress": "00:50:56:95:ec:bc", + "networkId": "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VirtualNetworks/test-vnet", + "nicType": "vmxnet3", + "powerOnBoot": "enabled", + "networkMoRefId": "network-563661", + "networkMoName": "VM Network", + "deviceKey": 4000 + }} +OSProfileAdminPassword : +OSProfileAdminUsername : +OSProfileComputerName : +OSProfileGuestId : ubuntu64Guest +OSProfileOssku : Ubuntu Linux (64-bit) +OSProfileOstype : Linux +OSProfileToolsRunningStatus : guestToolsNotRunning +OSProfileToolsVersion : 10304 +OSProfileToolsVersionStatus : guestToolsUnmanaged +PlacementProfileClusterId : +PlacementProfileDatastoreId : +PlacementProfileHostId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Hosts/test-host +PlacementProfileResourcePoolId : +PowerState : poweredOn +ProvisioningState : Succeeded +ResourceGroupName : test-rg +ResourceUid : 4c9c3021-d32e-48f9-b8ac-9cb14ebf6d75 +Statuses : {{ + "type": "CustomizationCompleted", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:36.0000000Z" + }, { + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:45.2429702Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:45.2429702Z" + }} +StorageProfileDisk : {{ + "name": "disk_1", + "label": "Hard disk 1", + "diskObjectId": "7435-2000", + "diskSizeGB": 10, + "deviceKey": 2000, + "diskMode": "persistent", + "controllerKey": 1000, + "unitNumber": 0, + "diskType": "flat" + }} +StorageProfileScsiController : {{ + "type": "lsilogic", + "controllerKey": 1000, + "scsiCtlrUnitNumber": 7, + "sharing": "noSharing" + }} +SystemDataCreatedAt : 10/6/2023 12:28:17 PM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 12:28:17 PM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Type : microsoft.connectedvmwarevsphere/virtualmachineinstances +UefiSettingSecureBootEnabled : False +``` + +This command create a VM Instances of machine named `test-machine` in a resource group named `test-rg`. + +### Example 4: Create Virtual Machine with a VM Inventory +```powershell New-AzConnectedVMwareVM -ExtendedLocationName "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl" -ExtendedLocationType "CustomLocation" -InfrastructureProfileInventoryItemId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/vm-1528583" -MachineId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine-ps" ``` +```output +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +HardwareProfileCpuHotAddEnabled : False +HardwareProfileCpuHotRemoveEnabled : False +HardwareProfileMemoryHotAddEnabled : False +HardwareProfileMemorySizeMb : 8192 +HardwareProfileNumCoresPerSocket : 1 +HardwareProfileNumCpUs : 4 +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine-ps/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineInstances/default +InfrastructureProfileCustomResourceName : 9d8766c2-6e02-4553-8ae2-7c37a19cb45b +InfrastructureProfileFirmwareType : bios +InfrastructureProfileFolderPath : ArcPrivateClouds-67/test-folder +InfrastructureProfileInstanceUuid : 5015d462-e12c-623f-45ad-ddfecc541d51 +InfrastructureProfileInventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/vm-1528583 +InfrastructureProfileMoName : test-ps-vm +InfrastructureProfileMoRefId : vm-1528583 +InfrastructureProfileSmbiosUuid : 421532ab-22b5-67b4-41fd-829f0e7355b9 +InfrastructureProfileTemplateId : +InfrastructureProfileVCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +Name : default +NetworkProfileNetworkInterface : {{ + "ipSettings": { + "allocationMethod": "unset", + "dnsServers": [ "10.50.50.50", "10.50.10.50" ], + "gateway": [ "10.150.176.1", "fe80::201:11ff:fe11:1111" ], + "ipAddress": "10.150.176.96", + "subnetMask": "255.255.248.0", + "ipAddressInfo": [ + { + "ipAddress": "10.150.176.96", + "subnetMask": "255.255.248.0" + }, + { + "ipAddress": "2404:f801:4800:14:fcff:ae75:70f7:b9c4", + "subnetMask": "ffff:ffff:ffff:ffff:0000:0000:0000:0000" + }, + { + "ipAddress": "2404:f801:4800:14:727f:c295:1b88:7c2e", + "subnetMask": "ffff:ffff:ffff:ffff:0000:0000:0000:0000" + }, + { + "ipAddress": "fe80::de93:fcd0:8a22:2ff6", + "subnetMask": "ffff:ffff:ffff:ffff:0000:0000:0000:0000" + } + ] + }, + "label": "Network adapter 1", + "ipAddresses": [ "10.150.176.96", "2404:f801:4800:14:fcff:ae75:70f7:b9c4", "2404:f801:4800:14:727f:c295:1b88:7c2e", "fe80::de93:fcd0:8a22:2ff6" ], + "macAddress": "00:50:56:95:5e:81", + "nicType": "vmxnet3", + "powerOnBoot": "enabled", + "networkMoRefId": "network-563661", + "networkMoName": "VM Network", + "deviceKey": 4000 + }} +OSProfileAdminPassword : +OSProfileAdminUsername : +OSProfileComputerName : virtual-machine +OSProfileGuestId : ubuntu64Guest +OSProfileOssku : Ubuntu Linux (64-bit) +OSProfileOstype : Linux +OSProfileToolsRunningStatus : guestToolsRunning +OSProfileToolsVersion : 11360 +OSProfileToolsVersionStatus : guestToolsUnmanaged +PlacementProfileClusterId : +PlacementProfileDatastoreId : +PlacementProfileHostId : +PlacementProfileResourcePoolId : +PowerState : poweredOn +ProvisioningState : Succeeded +ResourceGroupName : test-rg +ResourceUid : 18ccf2b0-438a-4267-8cd7-49f3564bc668 +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:11:40.5846310Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:11:40.5846310Z" + }} +StorageProfileDisk : {{ + "label": "Hard disk 1", + "diskObjectId": "7406-2000", + "diskSizeGB": 32, + "deviceKey": 2000, + "diskMode": "persistent", + "controllerKey": 1000, + "unitNumber": 0, + "diskType": "flat" + }} +StorageProfileScsiController : {{ + "type": "lsilogic", + "controllerKey": 1000, + "scsiCtlrUnitNumber": 7, + "sharing": "noSharing" + }} +SystemDataCreatedAt : 10/6/2023 10:11:11 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 10:11:11 AM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Type : microsoft.connectedvmwarevsphere/virtualmachineinstances +UefiSettingSecureBootEnabled : False +``` + +This command enable a VM Instances of machine named `test-machine` from a invetory vm in a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -83,22 +470,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -159,7 +531,7 @@ Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -175,7 +547,7 @@ Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -188,36 +560,6 @@ Type: System.Int32 Parameter Sets: CreateExpanded Aliases: -Required: False -Position: Named -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -347,7 +689,6 @@ Accept wildcard characters: False ### -NetworkProfileNetworkInterface Gets or sets the list of network interfaces associated with the virtual machine. -To construct, see NOTES section for NETWORKPROFILENETWORKINTERFACE properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.INetworkInterface[] @@ -371,7 +712,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -511,28 +852,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -541,24 +867,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -StorageProfileDisk Gets or sets the list of virtual disks associated with the virtual machine. -To construct, see NOTES section for STORAGEPROFILEDISK properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVirtualDisk[] @@ -582,7 +892,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -626,35 +936,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVirtualMachineInstance + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -NETWORKPROFILENETWORKINTERFACE \: Gets or sets the list of network interfaces associated with the virtual machine. - \[DeviceKey \\]: Gets or sets the device key value. - \[IPSettingAllocationMethod \\]: Gets or sets the nic allocation method. - \[IPSettingDnsServer \\>\]: Gets or sets the dns servers. - \[IPSettingGateway \\>\]: Gets or sets the gateway. - \[IPSettingIpaddress \\]: Gets or sets the ip address for the nic. - \[IPSettingSubnetMask \\]: Gets or sets the mask. - \[Name \\]: Gets or sets the name of the network interface. - \[NetworkId \\]: Gets or sets the ARM Id of the network resource to connect the virtual machine. - \[NicType \\]: NIC type - \[PowerOnBoot \\]: Gets or sets the power on boot. - -STORAGEPROFILEDISK \: Gets or sets the list of virtual disks associated with the virtual machine. - \[ControllerKey \\]: Gets or sets the controller id. - \[DeviceKey \\]: Gets or sets the device key value. - \[DeviceName \\]: Gets or sets the device name. - \[DiskMode \\]: Gets or sets the disk mode. - \[DiskSizeGb \\]: Gets or sets the disk total size. - \[DiskType \\]: Gets or sets the disk backing type. - \[Name \\]: Gets or sets the name of the virtual disk. - \[UnitNumber \\]: Gets or sets the unit number of the disk on the controller. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarevm](https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarevm) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVMGuestAgent.md b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVMGuestAgent.md index 33f5e1ec6f09..9de034f63138 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVMGuestAgent.md +++ b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVMGuestAgent.md @@ -16,25 +16,20 @@ Create GuestAgent. ``` New-AzConnectedVMwareVMGuestAgent -MachineId [-CredentialsPassword ] [-CredentialsUsername ] [-HttpProxyConfigHttpsProxy ] [-PrivateLinkScopeResourceId ] - [-ProvisioningAction ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ProvisioningAction ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzConnectedVMwareVMGuestAgent -MachineId -JsonFilePath [-DefaultProfile ] - [-AsJob] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzConnectedVMwareVMGuestAgent -MachineId -JsonString [-DefaultProfile ] - [-AsJob] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -42,11 +37,44 @@ Create GuestAgent. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Enable Guest Agent on VM Instances +```powershell New-AzConnectedVMwareVMGuestAgent -MachineId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine" -CredentialsUsername "test-user" -CredentialsPassword "test-pw" -ProvisioningAction "install" ``` +```output +CredentialsPassword : +CredentialsUsername : abc +CustomResourceName : d04a3534-2dfa-42c8-8959-83796a1bcac1 +HttpProxyConfigHttpsProxy : +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineInstances/default/guestAgents/default +Name : default +PrivateLinkScopeResourceId : +ProvisioningAction : install +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Status : Enabled +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T14:47:02.1828535Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T14:47:02.1828535Z" + }} +SystemDataCreatedAt : 10/6/2023 2:45:33 PM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 2:45:33 PM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Type : microsoft.connectedvmwarevsphere/virtualmachineinstances/guestagents +Uuid : 6a37a700-e02c-476d-a19f-258761575c40 +``` + +This command Enable Guest Agent of a VM Instances of machine named `test-machine`. + ## PARAMETERS ### -AsJob @@ -59,22 +87,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -125,36 +138,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -HttpProxyConfigHttpsProxy Gets or sets httpsProxy url. @@ -225,7 +208,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -245,28 +228,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProvisioningAction -Gets or sets the guest agent provisioning action. - -```yaml -Type: System.String -Parameter Sets: CreateExpanded -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -275,12 +243,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProvisioningAction +Gets or sets the guest agent provisioning action. ```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateExpanded Aliases: Required: False @@ -290,21 +258,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -344,9 +297,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IGuestAgent + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarevmguestagent](https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarevmguestagent) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVMTemplate.md b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVMTemplate.md index 90d38d21a631..b1d34a1d85bb 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVMTemplate.md +++ b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVMTemplate.md @@ -15,27 +15,23 @@ Create virtual machine template. ### CreateExpanded (Default) ``` New-AzConnectedVMwareVMTemplate -Name -ResourceGroupName [-SubscriptionId ] - -Location [-ExtendedLocationName ] [-ExtendedLocationType ] - [-InventoryItemId ] [-Kind ] [-MoRefId ] [-Tag ] [-VCenterId ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ExtendedLocationName ] [-ExtendedLocationType ] [-InventoryItemId ] [-Kind ] + [-Location ] [-MoRefId ] [-Tag ] [-VCenterId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzConnectedVMwareVMTemplate -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzConnectedVMwareVMTemplate -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -43,11 +39,81 @@ Create virtual machine template. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create VM Template +```powershell New-AzConnectedVMwareVMTemplate -Name "test-vmtmpl" -ResourceGroupName "test-rg" -Location "eastus" -ExtendedLocationName "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl" -ExtendedLocationType "CustomLocation" -InventoryItemId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/vmtpl-vm-651858" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +```output +CustomResourceName : b0d6ffc9-26a0-4099-b117-b7d8241c6243 +Disk : {{ + "name": "disk_1", + "label": "Hard disk 1", + "diskObjectId": "1-2000", + "diskSizeGB": 10, + "deviceKey": 2000, + "diskMode": "persistent", + "controllerKey": 1000, + "unitNumber": 0, + "diskType": "flat" + }} +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +FirmwareType : +FolderPath : ArcPrivateClouds-67/Templates +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/test-vmtmpl +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/vmtpl-vm-651858 +Kind : +Location : eastus +MemorySizeMb : 1024 +MoName : azurevmwarecloudtestubuntu +MoRefId : vm-651858 +Name : test-vmtmpl +NetworkInterface : {{ + "ipSettings": { + "allocationMethod": "unset" + }, + "name": "nic_1", + "label": "Network adapter 1", + "macAddress": "00:50:56:95:c7:08", + "nicType": "vmxnet3", + "powerOnBoot": "enabled", + "networkMoRefId": "network-563661", + "networkMoName": "VM Network", + "deviceKey": 4000 + }} +NumCoresPerSocket : 1 +NumCpUs : 1 +OSName : Ubuntu Linux (64-bit) +OSType : Linux +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T11:02:11.5393195Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T11:02:11.5393195Z" + }} +SystemDataCreatedAt : 10/6/2023 11:01:59 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 11:01:59 AM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + } +ToolsVersion : 10304 +ToolsVersionStatus : guestToolsSupportedOld +Type : microsoft.connectedvmwarevsphere/virtualmachinetemplates +Uuid : b0d6ffc9-26a0-4099-b117-b7d8241c6243 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` + +This command create a VM Template named `test-vmtmpl` in a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -60,22 +126,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -126,36 +177,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InventoryItemId Gets or sets the inventory Item ID for the virtual machine template. @@ -226,7 +247,7 @@ Type: System.String Parameter Sets: CreateExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -271,21 +292,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -293,13 +299,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -308,21 +314,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -348,7 +339,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -422,9 +413,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVirtualMachineTemplate + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarevmtemplate](https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarevmtemplate) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVNet.md b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVNet.md index 25b5aac1d39f..8c5d8ecf646e 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVNet.md +++ b/src/ConnectedVMware/ConnectedVMware/help/New-AzConnectedVMwareVNet.md @@ -15,27 +15,23 @@ Create virtual network. ### CreateExpanded (Default) ``` New-AzConnectedVMwareVNet -Name -ResourceGroupName [-SubscriptionId ] - -Location [-ExtendedLocationName ] [-ExtendedLocationType ] - [-InventoryItemId ] [-Kind ] [-MoRefId ] [-Tag ] [-VCenterId ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ExtendedLocationName ] [-ExtendedLocationType ] [-InventoryItemId ] [-Kind ] + [-Location ] [-MoRefId ] [-Tag ] [-VCenterId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzConnectedVMwareVNet -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzConnectedVMwareVNet -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -43,11 +39,48 @@ Create virtual network. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create Virtual Network +```powershell New-AzConnectedVMwareVNet -Name "test-vnet" -ResourceGroupName "test-rg" -Location "eastus" -ExtendedLocationName "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl" -ExtendedLocationType "CustomLocation" -InventoryItemId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/network-563661" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +```output +CustomResourceName : 1c967ed8-79f5-4737-aae9-0978e1128da6 +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/virtualNetworks/test-vnet +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/network-563661 +Kind : +Location : eastus +MoName : VM Network +MoRefId : network-563661 +Name : test-vnet +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T11:07:38.9615735Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T11:07:38.9615735Z" + }} +SystemDataCreatedAt : 10/6/2023 11:07:19 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 11:07:19 AM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + } +Type : microsoft.connectedvmwarevsphere/virtualnetworks +Uuid : 1c967ed8-79f5-4737-aae9-0978e1128da6 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` + +This command create a Virtual Network named `test-vnet` in a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -60,22 +93,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -126,36 +144,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InventoryItemId Gets or sets the inventory Item ID for the virtual network. @@ -226,7 +214,7 @@ Type: System.String Parameter Sets: CreateExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -271,21 +259,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -293,13 +266,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -308,21 +281,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -348,7 +306,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -422,9 +380,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVirtualNetwork + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarevnet](https://learn.microsoft.com/powershell/module/az.connectedvmware/new-azconnectedvmwarevnet) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareCluster.md b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareCluster.md index 144f7eb45421..0563957ecf98 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareCluster.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareCluster.md @@ -15,17 +15,15 @@ Implements cluster DELETE method. ### Delete (Default) ``` Remove-AzConnectedVMwareCluster -Name -ResourceGroupName [-SubscriptionId ] - [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzConnectedVMwareCluster -InputObject [-ForceDeletion] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -33,11 +31,13 @@ Implements cluster DELETE method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete Cluster +```powershell Remove-AzConnectedVMwareCluster -Name "test-cluster" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +This command delete a Cluster named `test-cluster` from a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -50,22 +50,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -94,36 +79,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -133,7 +88,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -172,7 +126,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -185,21 +139,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -207,13 +146,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -222,21 +161,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -262,7 +186,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -304,30 +228,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### System.Boolean + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwarecluster](https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwarecluster) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareDatastore.md b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareDatastore.md index 51512b52f5e3..889d1362a466 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareDatastore.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareDatastore.md @@ -15,17 +15,15 @@ Implements datastore DELETE method. ### Delete (Default) ``` Remove-AzConnectedVMwareDatastore -Name -ResourceGroupName [-SubscriptionId ] - [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzConnectedVMwareDatastore -InputObject [-ForceDeletion] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -33,11 +31,13 @@ Implements datastore DELETE method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete Datastore +```powershell Remove-AzConnectedVMwareDatastore -Name "test-datastore" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +This command delete a Datastore named `test-datastore` from a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -50,22 +50,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -94,36 +79,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -133,7 +88,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -172,7 +126,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -185,21 +139,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -207,13 +146,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -222,21 +161,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -262,7 +186,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -304,30 +228,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### System.Boolean + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwaredatastore](https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwaredatastore) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareHost.md b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareHost.md index 541da71a9b2e..1f5d48091731 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareHost.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareHost.md @@ -15,17 +15,15 @@ Implements host DELETE method. ### Delete (Default) ``` Remove-AzConnectedVMwareHost -Name -ResourceGroupName [-SubscriptionId ] - [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzConnectedVMwareHost -InputObject [-ForceDeletion] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -33,11 +31,13 @@ Implements host DELETE method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete Host +```powershell Remove-AzConnectedVMwareHost -Name "test-host" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +This command delete a Host named `test-host` from a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -50,22 +50,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -94,36 +79,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -133,7 +88,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -172,7 +126,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -185,21 +139,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -207,13 +146,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -222,21 +161,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -262,7 +186,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -304,30 +228,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### System.Boolean + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwarehost](https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwarehost) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareResourcePool.md b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareResourcePool.md index a8f971ebc062..bc3208ef7306 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareResourcePool.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareResourcePool.md @@ -15,17 +15,15 @@ Implements resourcePool DELETE method. ### Delete (Default) ``` Remove-AzConnectedVMwareResourcePool -Name -ResourceGroupName [-SubscriptionId ] - [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzConnectedVMwareResourcePool -InputObject [-ForceDeletion] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -33,11 +31,13 @@ Implements resourcePool DELETE method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete Resource Pool +```powershell Remove-AzConnectedVMwareResourcePool -Name "test-rp" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +This command delete a Resource Pool named `test-rp` from a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -50,22 +50,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -94,36 +79,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -133,7 +88,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -172,7 +126,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -185,21 +139,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -207,13 +146,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -222,21 +161,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -262,7 +186,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -304,30 +228,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### System.Boolean + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwareresourcepool](https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwareresourcepool) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVCenter.md b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVCenter.md index d699fb9087dd..10195e782508 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVCenter.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVCenter.md @@ -15,17 +15,15 @@ Implements vCenter DELETE method. ### Delete (Default) ``` Remove-AzConnectedVMwareVCenter -Name -ResourceGroupName [-SubscriptionId ] - [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzConnectedVMwareVCenter -InputObject [-ForceDeletion] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -33,11 +31,13 @@ Implements vCenter DELETE method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete VCenter +```powershell Remove-AzConnectedVMwareVCenter -Name "test-vc" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +This command delete a VCenter named `test-vc` from a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -50,22 +50,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -94,36 +79,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -133,7 +88,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -172,7 +126,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -185,21 +139,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -207,13 +146,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -222,21 +161,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -262,7 +186,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -304,30 +228,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### System.Boolean + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwarevcenter](https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwarevcenter) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVM.md b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVM.md index 9fc5595149f3..3ec9153d589e 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVM.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVM.md @@ -14,9 +14,7 @@ The operation to delete a virtual machine instance. ``` Remove-AzConnectedVMwareVM -MachineId [-DeleteFromHost] [-ForceDeletion] [-DefaultProfile ] - [-AsJob] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-PassThru] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] - [-Confirm] [] + [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -24,11 +22,13 @@ The operation to delete a virtual machine instance. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete VM Instances +```powershell Remove-AzConnectedVMwareVM -MachineId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/azcli-test-rg/providers/Microsoft.HybridCompute/machines/test-machine" ``` +This command will delete of a VM Instances of machine named `test-machine`. + ## PARAMETERS ### -AsJob @@ -41,22 +41,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -87,7 +72,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -100,36 +85,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -162,7 +117,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -175,21 +130,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -197,13 +137,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -212,21 +152,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -266,9 +191,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Boolean + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwarevm](https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwarevm) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVMTemplate.md b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVMTemplate.md index a81300ad6f5b..e6974592129d 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVMTemplate.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVMTemplate.md @@ -15,17 +15,15 @@ Implements virtual machine template DELETE method. ### Delete (Default) ``` Remove-AzConnectedVMwareVMTemplate -Name -ResourceGroupName [-SubscriptionId ] - [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzConnectedVMwareVMTemplate -InputObject [-ForceDeletion] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -33,11 +31,13 @@ Implements virtual machine template DELETE method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete VM Template +```powershell Remove-AzConnectedVMwareVMTemplate -Name "test-vmtmpl" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +This command delete a VM Template named `test-vmtmpl` from a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -50,22 +50,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -94,36 +79,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -133,7 +88,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -172,7 +126,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -185,21 +139,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -207,13 +146,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -222,21 +161,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -262,7 +186,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -304,30 +228,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### System.Boolean + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwarevmtemplate](https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwarevmtemplate) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVNet.md b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVNet.md index 7c13ee7da334..9d98964f1cfe 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVNet.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Remove-AzConnectedVMwareVNet.md @@ -15,17 +15,15 @@ Implements virtual network DELETE method. ### Delete (Default) ``` Remove-AzConnectedVMwareVNet -Name -ResourceGroupName [-SubscriptionId ] - [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-ForceDeletion] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzConnectedVMwareVNet -InputObject [-ForceDeletion] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -33,11 +31,13 @@ Implements virtual network DELETE method. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete Virtual Network +```powershell Remove-AzConnectedVMwareVNet -Name "test-vnet" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" ``` +This command delete a Virtual Network named `test-vnet` from a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -50,22 +50,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -94,36 +79,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -133,7 +88,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -172,7 +126,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -185,21 +139,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -207,13 +146,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -222,21 +161,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -262,7 +186,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -304,30 +228,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### System.Boolean + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwarevnet](https://learn.microsoft.com/powershell/module/az.connectedvmware/remove-azconnectedvmwarevnet) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Restart-AzConnectedVMwareVM.md b/src/ConnectedVMware/ConnectedVMware/help/Restart-AzConnectedVMwareVM.md index 3737c87bc0a2..a511e1c17bc0 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Restart-AzConnectedVMwareVM.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Restart-AzConnectedVMwareVM.md @@ -13,9 +13,8 @@ The operation to restart a virtual machine instance. ## SYNTAX ``` -Restart-AzConnectedVMwareVM -MachineId [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Restart-AzConnectedVMwareVM -MachineId [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -23,11 +22,13 @@ The operation to restart a virtual machine instance. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Restart Virtual Machine +```powershell Restart-AzConnectedVMwareVM -MachineId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/azcli-test-rg/providers/Microsoft.HybridCompute/machines/test-machine" ``` +This command restart of a VM named `test-vm` in a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -40,22 +41,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,36 +62,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -MachineId The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. @@ -129,21 +85,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -151,13 +92,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -166,21 +107,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -220,9 +146,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Boolean + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/restart-azconnectedvmwarevm](https://learn.microsoft.com/powershell/module/az.connectedvmware/restart-azconnectedvmwarevm) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Start-AzConnectedVMwareVM.md b/src/ConnectedVMware/ConnectedVMware/help/Start-AzConnectedVMwareVM.md index 4d3e032f51ad..4a2bc1cad154 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Start-AzConnectedVMwareVM.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Start-AzConnectedVMwareVM.md @@ -13,9 +13,8 @@ The operation to start a virtual machine instance. ## SYNTAX ``` -Start-AzConnectedVMwareVM -MachineId [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Start-AzConnectedVMwareVM -MachineId [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -23,11 +22,13 @@ The operation to start a virtual machine instance. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Start Virtual Machine +```powershell Start-AzConnectedVMwareVM -MachineId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/azcli-test-rg/providers/Microsoft.HybridCompute/machines/test-machine" ``` +This command start of a VM named `test-vm` in a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -40,22 +41,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,36 +62,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -MachineId The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. @@ -129,21 +85,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -151,13 +92,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -166,21 +107,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -220,9 +146,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Boolean + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/start-azconnectedvmwarevm](https://learn.microsoft.com/powershell/module/az.connectedvmware/start-azconnectedvmwarevm) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Stop-AzConnectedVMwareVM.md b/src/ConnectedVMware/ConnectedVMware/help/Stop-AzConnectedVMwareVM.md index be1a4f17c1f7..319d589ea691 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Stop-AzConnectedVMwareVM.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Stop-AzConnectedVMwareVM.md @@ -14,33 +14,26 @@ The operation to power off (stop) a virtual machine instance. ### StopExpanded (Default) ``` -Stop-AzConnectedVMwareVM -MachineId [-SkipShutdown] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Stop-AzConnectedVMwareVM -MachineId [-SkipShutdown] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### Stop ``` Stop-AzConnectedVMwareVM -MachineId -Body [-DefaultProfile ] - [-AsJob] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### StopViaJsonFilePath ``` Stop-AzConnectedVMwareVM -MachineId -JsonFilePath [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### StopViaJsonString ``` Stop-AzConnectedVMwareVM -MachineId -JsonString [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -48,11 +41,13 @@ The operation to power off (stop) a virtual machine instance. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Stop Virtual Machine +```powershell Stop-AzConnectedVMwareVM -MachineId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/azcli-test-rg/providers/Microsoft.HybridCompute/machines/test-machine" ``` +This command stop of a VM named `test-vm` in a resource group named `test-rg`. + ## PARAMETERS ### -AsJob @@ -65,14 +60,13 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Body Defines the stop action properties. -To construct, see NOTES section for BODY properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IStopVirtualMachineOptions @@ -86,21 +80,6 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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. @@ -117,36 +96,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -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 Stop operation @@ -200,21 +149,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -222,13 +156,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -237,21 +171,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -SkipShutdown Gets or sets a value indicating whether to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. @@ -264,7 +183,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -306,21 +225,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IStopVirtualMachineOptions + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -BODY \: Defines the stop action properties. - \[SkipShutdown \\]: Gets or sets a value indicating whether to request non-graceful VM shutdown. -True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. -Defaults to false. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/stop-azconnectedvmwarevm](https://learn.microsoft.com/powershell/module/az.connectedvmware/stop-azconnectedvmwarevm) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareCluster.md b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareCluster.md index cb683a52c1c8..d99c5b95d623 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareCluster.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareCluster.md @@ -15,33 +15,28 @@ API to update certain properties of the cluster resource. ### UpdateExpanded (Default) ``` Update-AzConnectedVMwareCluster -Name -ResourceGroupName [-SubscriptionId ] - [-Tag ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-Tag ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonString ``` Update-AzConnectedVMwareCluster -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonFilePath ``` Update-AzConnectedVMwareCluster -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzConnectedVMwareCluster -InputObject [-Tag ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,27 +44,56 @@ API to update certain properties of the cluster resource. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update Cluster Resource +```powershell Update-AzConnectedVMwareCluster -Name "test-cluster" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" -Tag @{"cluster"="test"} ``` -## PARAMETERS +```output +CustomResourceName : 1040d770-249a-4b2c-b7f4-a2ed32b05f81 +DatastoreId : {/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Datastores/test-datastore} +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/clusters/test-cluster +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/domain-c649660 +Kind : +Location : eastus +MoName : Cluster1 +MoRefId : domain-c649660 +Name : test-cluster +NetworkId : {/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VirtualNetworks/test-vnet} +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:45:36.1775643Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:45:36.1775643Z" + }} +SystemDataCreatedAt : 10/6/2023 10:45:17 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 2:22:50 PM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + "cluster": "test" + } +TotalCpuMHz : 210624 +TotalMemoryGb : 383 +Type : microsoft.connectedvmwarevsphere/clusters +UsedCpuMHz : 55860 +UsedMemoryGb : 359 +Uuid : 1040d770-249a-4b2c-b7f4-a2ed32b05f81 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` -### -Break -Wait for .NET debugger to attach +This command update tag of a Cluster named `test-cluster` in a resource group named `test-rg`. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -87,39 +111,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -178,28 +171,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -208,21 +186,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -248,7 +211,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -305,30 +268,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.ICluster + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwarecluster](https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwarecluster) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareDatastore.md b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareDatastore.md index 50a017f3fa7e..1f678adbe650 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareDatastore.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareDatastore.md @@ -15,33 +15,28 @@ API to update certain properties of the datastore resource. ### UpdateExpanded (Default) ``` Update-AzConnectedVMwareDatastore -Name -ResourceGroupName [-SubscriptionId ] - [-Tag ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-Tag ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonString ``` Update-AzConnectedVMwareDatastore -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonFilePath ``` Update-AzConnectedVMwareDatastore -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzConnectedVMwareDatastore -InputObject [-Tag ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,27 +44,52 @@ API to update certain properties of the datastore resource. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update Datastore +```powershell Update-AzConnectedVMwareDatastore -Name "test-datastore" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" -Tag @{"datastore"="test"} ``` -## PARAMETERS +```output +CapacityGb : 46079 +CustomResourceName : 9a2cb7ed-52a7-4fad-be88-6ff3794f80c7 +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +FreeSpaceGb : 13616 +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/datastores/test-datastore +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/datastore-563660 +Kind : +Location : eastus +MoName : Shared 15TB +MoRefId : datastore-563660 +Name : test-datastore +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:50:38.1524028Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:50:38.1524028Z" + }} +SystemDataCreatedAt : 10/6/2023 10:50:21 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 2:24:36 PM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + "datastore": "test" + } +Type : microsoft.connectedvmwarevsphere/datastores +Uuid : 9a2cb7ed-52a7-4fad-be88-6ff3794f80c7 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` -### -Break -Wait for .NET debugger to attach +This command update tag of a Datastore named `test-datastore` in a resource group named `test-rg`. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -87,39 +107,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -178,28 +167,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -208,21 +182,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -248,7 +207,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -305,30 +264,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IDatastore + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwaredatastore](https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwaredatastore) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareHost.md b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareHost.md index 8343cbe199e4..bb5c1ecd9d93 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareHost.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareHost.md @@ -15,33 +15,28 @@ API to update certain properties of the host resource. ### UpdateExpanded (Default) ``` Update-AzConnectedVMwareHost -Name -ResourceGroupName [-SubscriptionId ] - [-Tag ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-Tag ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonString ``` Update-AzConnectedVMwareHost -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonFilePath ``` Update-AzConnectedVMwareHost -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzConnectedVMwareHost -InputObject [-Tag ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,27 +44,56 @@ API to update certain properties of the host resource. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update Host +```powershell Update-AzConnectedVMwareHost -Name "test-host" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" -Tag @{"host"="test"} ``` -## PARAMETERS +```output +CpuMhz : 105312 +CustomResourceName : 6d40fd86-6f29-44ed-8e3a-fa7a11b5f1ac +DatastoreId : {/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Datastores/test-datastore} +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/hosts/test-host +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/host-1147412 +Kind : +Location : eastus +MemorySizeGb : 127 +MoName : 10.150.178.208 +MoRefId : host-1147412 +Name : test-host +NetworkId : {/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VirtualNetworks/test-vnet} +OverallCpuUsageMHz : 21998 +OverallMemoryUsageGb : 117 +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:54:23.2077585Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:54:23.2077585Z" + }} +SystemDataCreatedAt : 10/6/2023 10:54:13 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 2:26:09 PM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + "host": "test" + } +Type : microsoft.connectedvmwarevsphere/hosts +Uuid : 6d40fd86-6f29-44ed-8e3a-fa7a11b5f1ac +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` -### -Break -Wait for .NET debugger to attach +This command update tag of a Host named `test-host` in a resource group named `test-rg`. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -87,39 +111,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -178,28 +171,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -208,21 +186,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -248,7 +211,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -305,30 +268,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IHost + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwarehost](https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwarehost) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareResourcePool.md b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareResourcePool.md index 45b115c8bfe6..e30669da4f4e 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareResourcePool.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareResourcePool.md @@ -15,33 +15,28 @@ API to update certain properties of the resourcePool resource. ### UpdateExpanded (Default) ``` Update-AzConnectedVMwareResourcePool -Name -ResourceGroupName [-SubscriptionId ] - [-Tag ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-Tag ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonString ``` Update-AzConnectedVMwareResourcePool -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonFilePath ``` Update-AzConnectedVMwareResourcePool -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzConnectedVMwareResourcePool -InputObject [-Tag ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,27 +44,62 @@ API to update certain properties of the resourcePool resource. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update Resource Pool +```powershell Update-AzConnectedVMwareResourcePool -Name "test-rp" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" -Tag @{"rp"="test"} ``` -## PARAMETERS +```output +CpuCapacityMHz : 197132 +CpuLimitMHz : -1 +CpuOverallUsageMHz : 1030 +CpuReservationMHz : +CpuSharesLevel : normal +CustomResourceName : e296ddc2-ab72-4bba-9bf9-9fb18abaabf7 +DatastoreId : {/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Datastores/test-datastore} +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/resourcePools/test-rp +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/resgroup-724471 +Kind : +Location : eastus +MemCapacityGb : 344 +MemLimitMb : -1 +MemOverallUsageGb : 11 +MemReservationMb : +MemSharesLevel : normal +MoName : test-rp +MoRefId : resgroup-724471 +Name : test-rp +NetworkId : {/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VirtualNetworks/test-vnet} +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:58:30.1697443Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T10:58:30.1697443Z" + }} +SystemDataCreatedAt : 10/6/2023 10:58:11 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 2:28:01 PM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + "rp": "test" + } +Type : microsoft.connectedvmwarevsphere/resourcepools +Uuid : e296ddc2-ab72-4bba-9bf9-9fb18abaabf7 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` -### -Break -Wait for .NET debugger to attach +This command update tag of a Resource Pool named `test-rp` in a resource group named `test-rg`. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -87,39 +117,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -178,28 +177,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -208,21 +192,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -248,7 +217,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -305,30 +274,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IResourcePool + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwareresourcepool](https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwareresourcepool) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVCenter.md b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVCenter.md index cbbff2eb8a82..563410f89ece 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVCenter.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVCenter.md @@ -15,33 +15,28 @@ API to update certain properties of the vCenter resource. ### UpdateExpanded (Default) ``` Update-AzConnectedVMwareVCenter -Name -ResourceGroupName [-SubscriptionId ] - [-Tag ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-Tag ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonString ``` Update-AzConnectedVMwareVCenter -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonFilePath ``` Update-AzConnectedVMwareVCenter -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzConnectedVMwareVCenter -InputObject [-Tag ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,27 +44,57 @@ API to update certain properties of the vCenter resource. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update VCenter +```powershell Update-AzConnectedVMwareVCenter -Name "test-vc" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" -Tag @{"vc"="test"} ``` -## PARAMETERS +```output +ConnectionStatus : Connected +CredentialsPassword : +CredentialsUsername : abc +CustomResourceName : e6048b2a-ba86-4334-adff-ba3d617d12ef +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Fqdn : idclab-vcen67.fareast.corp.microsoft.com +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc +InstanceUuid : db73f8f2-624c-4a0f-905b-8c6f34442cbc +Kind : VMware +Location : eastus +Name : test-vc +Port : 443 +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Connected", + "status": "True", + "lastUpdatedAt": "2023-09-18T08:04:35.0000000Z" + }, { + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-08-01T05:26:07.8798425Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-08-01T05:26:07.8798425Z" + }} +SystemDataCreatedAt : 2/16/2023 3:53:39 PM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 2:30:18 PM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + "vc": "test" + } +Type : microsoft.connectedvmwarevsphere/vcenters +Uuid : e6048b2a-ba86-4334-adff-ba3d617d12ef +Version : 6.7.0 +``` -### -Break -Wait for .NET debugger to attach +This command update tag of a VCenter named `test-vc` in a resource group named `test-rg`. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -87,39 +112,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -178,28 +172,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -208,21 +187,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -248,7 +212,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -305,30 +269,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVCenter + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwarevcenter](https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwarevcenter) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVM.md b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVM.md index 4f39949b0ef6..454fad947f83 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVM.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVM.md @@ -17,25 +17,20 @@ The operation to update a virtual machine instance. Update-AzConnectedVMwareVM -MachineId [-HardwareProfileMemorySizeMb ] [-HardwareProfileNumCoresPerSocket ] [-HardwareProfileNumCpus ] [-NetworkProfileNetworkInterface ] [-StorageProfileDisk ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonFilePath ``` Update-AzConnectedVMwareVM -MachineId -JsonFilePath [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaJsonString ``` Update-AzConnectedVMwareVM -MachineId -JsonString [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -43,11 +38,106 @@ The operation to update a virtual machine instance. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update Virtual Machine Instances Resource Memory Size +```powershell Update-AzConnectedVMwareVM -MachineId "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine" -HardwareProfileMemorySizeMb 2048 ``` +```output +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +HardwareProfileCpuHotAddEnabled : True +HardwareProfileCpuHotRemoveEnabled : False +HardwareProfileMemoryHotAddEnabled : True +HardwareProfileMemorySizeMb : 2048 +HardwareProfileNumCoresPerSocket : 1 +HardwareProfileNumCpus : 1 +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.HybridCompute/machines/test-machine/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineInstances/default +InfrastructureProfileCustomResourceName : d04a3534-2dfa-42c8-8959-83796a1bcac1 +InfrastructureProfileFirmwareType : bios +InfrastructureProfileFolderPath : ArcPrivateClouds-67 +InfrastructureProfileInstanceUuid : d04a3534-2dfa-42c8-8959-83796a1bcac1 +InfrastructureProfileInventoryItemId : +InfrastructureProfileMoName : test-machine +InfrastructureProfileMoRefId : vm-1529269 +InfrastructureProfileSmbiosUuid : 4215b305-5f69-959b-0620-16a5bd8c5fc9 +InfrastructureProfileTemplateId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/test-vmtmpl +InfrastructureProfileVCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc +Name : default +NetworkProfileNetworkInterface : {{ + "ipSettings": { + "allocationMethod": "unset" + }, + "name": "nic_1", + "label": "Network adapter 1", + "ipAddresses": [ "10.150.176.100", "fe80::250:56ff:fe95:ecbc", "2404:f801:4800:14:250:56ff:fe95:ecbc" ], + "macAddress": "00:50:56:95:ec:bc", + "networkId": "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VirtualNetworks/test-vnet", + "nicType": "vmxnet3", + "powerOnBoot": "enabled", + "networkMoRefId": "network-563661", + "networkMoName": "VM Network", + "deviceKey": 4000 + }} +OSProfileAdminPassword : +OSProfileAdminUsername : +OSProfileComputerName : test-machine +OSProfileGuestId : ubuntu64Guest +OSProfileOssku : Ubuntu Linux (64-bit) +OSProfileOstype : Linux +OSProfileToolsRunningStatus : guestToolsRunning +OSProfileToolsVersion : 10304 +OSProfileToolsVersionStatus : guestToolsUnmanaged +PlacementProfileClusterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Clusters/test-cluster +PlacementProfileDatastoreId : +PlacementProfileHostId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/Hosts/test-host +PlacementProfileResourcePoolId : +PowerState : poweredOn +ProvisioningState : Succeeded +ResourceGroupName : test-rg +ResourceUid : 4c9c3021-d32e-48f9-b8ac-9cb14ebf6d75 +Statuses : {{ + "type": "CustomizationCompleted", + "status": "True", + "lastUpdatedAt": "2023-10-06T12:29:36.0000000Z" + }, { + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T14:09:12.3939694Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T14:09:12.3939694Z" + }} +StorageProfileDisk : {{ + "name": "disk_1", + "label": "Hard disk 1", + "diskObjectId": "7435-2000", + "diskSizeGB": 10, + "deviceKey": 2000, + "diskMode": "persistent", + "controllerKey": 1000, + "unitNumber": 0, + "diskType": "flat" + }} +StorageProfileScsiController : {{ + "type": "lsilogic", + "controllerKey": 1000, + "scsiCtlrUnitNumber": 7, + "sharing": "noSharing" + }} +SystemDataCreatedAt : 10/6/2023 12:28:17 PM +SystemDataCreatedBy : sanmishra@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 2:09:19 PM +SystemDataLastModifiedBy : ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7 +SystemDataLastModifiedByType : Application +Type : microsoft.connectedvmwarevsphere/virtualmachineinstances +UefiSettingSecureBootEnabled : False +``` + +This command update Memory Size of a VM Instances of machine named `test-machine`. + ## PARAMETERS ### -AsJob @@ -60,22 +150,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -106,7 +181,7 @@ Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -122,7 +197,7 @@ Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -135,36 +210,6 @@ Type: System.Int32 Parameter Sets: UpdateExpanded Aliases: -Required: False -Position: Named -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -219,7 +264,6 @@ Accept wildcard characters: False ### -NetworkProfileNetworkInterface Gets or sets the list of network interfaces associated with the virtual machine. -To construct, see NOTES section for NETWORKPROFILENETWORKINTERFACE properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.INetworkInterfaceUpdate[] @@ -241,21 +285,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -263,13 +292,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -278,24 +307,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -StorageProfileDisk Gets or sets the list of virtual disks associated with the virtual machine. -To construct, see NOTES section for STORAGEPROFILEDISK properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVirtualDiskUpdate[] @@ -348,30 +361,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVirtualMachineInstance + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -NETWORKPROFILENETWORKINTERFACE \: Gets or sets the list of network interfaces associated with the virtual machine. - \[DeviceKey \\]: Gets or sets the device key value. - \[Name \\]: Gets or sets the name of the network interface. - \[NetworkId \\]: Gets or sets the ARM Id of the network resource to connect the virtual machine. - \[NicType \\]: NIC type - \[PowerOnBoot \\]: Gets or sets the power on boot. - -STORAGEPROFILEDISK \: Gets or sets the list of virtual disks associated with the virtual machine. - \[ControllerKey \\]: Gets or sets the controller id. - \[DeviceKey \\]: Gets or sets the device key value. - \[DeviceName \\]: Gets or sets the device name. - \[DiskMode \\]: Gets or sets the disk mode. - \[DiskSizeGb \\]: Gets or sets the disk total size. - \[DiskType \\]: Gets or sets the disk backing type. - \[Name \\]: Gets or sets the name of the virtual disk. - \[UnitNumber \\]: Gets or sets the unit number of the disk on the controller. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwarevm](https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwarevm) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVMTemplate.md b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVMTemplate.md index a726c8730d40..df04e426237c 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVMTemplate.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVMTemplate.md @@ -15,33 +15,28 @@ API to update certain properties of the virtual machine template resource. ### UpdateExpanded (Default) ``` Update-AzConnectedVMwareVMTemplate -Name -ResourceGroupName [-SubscriptionId ] - [-Tag ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-Tag ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonString ``` Update-AzConnectedVMwareVMTemplate -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonFilePath ``` Update-AzConnectedVMwareVMTemplate -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzConnectedVMwareVMTemplate -InputObject [-Tag ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,27 +44,84 @@ API to update certain properties of the virtual machine template resource. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update VM Template Resource +```powershell Update-AzConnectedVMwareVMTemplate -Name "test-vmtmpl" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" -Tag @{"vmtmpl"="test"} ``` -## PARAMETERS +```output +CustomResourceName : b0d6ffc9-26a0-4099-b117-b7d8241c6243 +Disk : {{ + "name": "disk_1", + "label": "Hard disk 1", + "diskObjectId": "1-2000", + "diskSizeGB": 10, + "deviceKey": 2000, + "diskMode": "persistent", + "controllerKey": 1000, + "unitNumber": 0, + "diskType": "flat" + }} +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +FirmwareType : +FolderPath : ArcPrivateClouds-67/Templates +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/test-vmtmpl +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/vmtpl-vm-651858 +Kind : +Location : eastus +MemorySizeMb : 1024 +MoName : azurevmwarecloudtestubuntu +MoRefId : vm-651858 +Name : test-vmtmpl +NetworkInterface : {{ + "ipSettings": { + "allocationMethod": "unset" + }, + "name": "nic_1", + "label": "Network adapter 1", + "macAddress": "00:50:56:95:c7:08", + "networkId": "/subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VirtualNetworks/test-vnet", + "nicType": "vmxnet3", + "powerOnBoot": "enabled", + "networkMoRefId": "network-563661", + "networkMoName": "VM Network", + "deviceKey": 4000 + }} +NumCoresPerSocket : 1 +NumCpUs : 1 +OSName : Ubuntu Linux (64-bit) +OSType : Linux +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T11:02:11.5393195Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T11:02:11.5393195Z" + }} +SystemDataCreatedAt : 10/6/2023 11:01:59 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 2:33:08 PM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + "vmtmpl": "test" + } +ToolsVersion : 10304 +ToolsVersionStatus : guestToolsSupportedOld +Type : microsoft.connectedvmwarevsphere/virtualmachinetemplates +Uuid : b0d6ffc9-26a0-4099-b117-b7d8241c6243 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` -### -Break -Wait for .NET debugger to attach +This command update tag of a VM Template named `test-vmtmpl` in a resource group named `test-rg`. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -87,39 +139,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -178,28 +199,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -208,21 +214,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -248,7 +239,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -305,30 +296,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVirtualMachineTemplate + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwarevmtemplate](https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwarevmtemplate) - diff --git a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVNet.md b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVNet.md index 878e14be091a..98b295af13be 100644 --- a/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVNet.md +++ b/src/ConnectedVMware/ConnectedVMware/help/Update-AzConnectedVMwareVNet.md @@ -15,33 +15,28 @@ API to update certain properties of the virtual network resource. ### UpdateExpanded (Default) ``` Update-AzConnectedVMwareVNet -Name -ResourceGroupName [-SubscriptionId ] - [-Tag ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-Tag ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonString ``` Update-AzConnectedVMwareVNet -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonFilePath ``` Update-AzConnectedVMwareVNet -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzConnectedVMwareVNet -InputObject [-Tag ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,27 +44,50 @@ API to update certain properties of the virtual network resource. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update Virtual Network Resource +```powershell Update-AzConnectedVMwareVNet -Name "test-vnet" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d" -Tag @{"vnet"="test"} ``` -## PARAMETERS +```output +CustomResourceName : 1c967ed8-79f5-4737-aae9-0978e1128da6 +ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl +ExtendedLocationType : CustomLocation +Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/virtualNetworks/test-vnet +InventoryItemId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc/InventoryItems/network-563661 +Kind : +Location : eastus +MoName : VM Network +MoRefId : network-563661 +Name : test-vnet +ProvisioningState : Succeeded +ResourceGroupName : test-rg +Statuses : {{ + "type": "Ready", + "status": "True", + "lastUpdatedAt": "2023-10-06T11:07:38.9615735Z" + }, { + "type": "Idle", + "status": "True", + "lastUpdatedAt": "2023-10-06T11:07:38.9615735Z" + }} +SystemDataCreatedAt : 10/6/2023 11:07:19 AM +SystemDataCreatedBy : xyz +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/6/2023 2:34:53 PM +SystemDataLastModifiedBy : xyz +SystemDataLastModifiedByType : User +Tag : { + "vnet": "test" + } +Type : microsoft.connectedvmwarevsphere/virtualnetworks +Uuid : 1c967ed8-79f5-4737-aae9-0978e1128da6 +VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/test-vc +``` -### -Break -Wait for .NET debugger to attach +This command update tag of a Virtual Network named `test-vnet` in a resource group named `test-rg`. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -87,39 +105,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity @@ -178,28 +165,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Uri +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -208,21 +180,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The Resource Group Name. @@ -248,7 +205,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -305,30 +262,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IVirtualNetwork + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ClusterName \\]: Name of the cluster. - \[DatastoreName \\]: Name of the datastore. - \[HostName \\]: Name of the host. - \[Id \\]: Resource identity path - \[InventoryItemName \\]: Name of the inventoryItem. - \[ResourceGroupName \\]: The Resource Group Name. - \[ResourcePoolName \\]: Name of the resourcePool. - \[ResourceUri \\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended. - \[SubscriptionId \\]: The Subscription ID. - \[VcenterName \\]: Name of the vCenter. - \[VirtualMachineTemplateName \\]: Name of the virtual machine template resource. - \[VirtualNetworkName \\]: Name of the virtual network resource. ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwarevnet](https://learn.microsoft.com/powershell/module/az.connectedvmware/update-azconnectedvmwarevnet) - diff --git a/src/CustomLocation/CustomLocation/help/Az.CustomLocation.md b/src/CustomLocation/CustomLocation/help/Az.CustomLocation.md index 5f3cf23e1de1..fc9074a6c882 100644 --- a/src/CustomLocation/CustomLocation/help/Az.CustomLocation.md +++ b/src/CustomLocation/CustomLocation/help/Az.CustomLocation.md @@ -11,18 +11,36 @@ Locale: en-US Microsoft Azure PowerShell: CustomLocation cmdlets ## Az.CustomLocation Cmdlets +### [Find-AzCustomLocationTargetResourceGroup](Find-AzCustomLocationTargetResourceGroup.md) +Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request. + ### [Get-AzCustomLocation](Get-AzCustomLocation.md) Gets the details of the customLocation with a specified resource group and name. ### [Get-AzCustomLocationEnabledResourceType](Get-AzCustomLocationEnabledResourceType.md) Gets the list of the Enabled Resource Types. +### [Get-AzCustomLocationResourceSyncRule](Get-AzCustomLocationResourceSyncRule.md) +Gets the details of the resourceSyncRule with a specified resource group, subscription id Custom Location resource name and Resource Sync Rule name. + ### [New-AzCustomLocation](New-AzCustomLocation.md) -Creates or updates a Custom Location in the specified Subscription and Resource Group +Create a Custom Location in the specified Subscription and Resource Group + +### [New-AzCustomLocationMatchExpressionsObject](New-AzCustomLocationMatchExpressionsObject.md) +Create an in-memory object for MatchExpressionsProperties. + +### [New-AzCustomLocationResourceSyncRule](New-AzCustomLocationResourceSyncRule.md) +Create a Resource Sync Rule in the parent Custom Location, Subscription Id and Resource Group ### [Remove-AzCustomLocation](Remove-AzCustomLocation.md) Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id. +### [Remove-AzCustomLocationResourceSyncRule](Remove-AzCustomLocationResourceSyncRule.md) +Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custom Location Resource Name, Resource Group, and Subscription Id. + ### [Update-AzCustomLocation](Update-AzCustomLocation.md) Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription. +### [Update-AzCustomLocationResourceSyncRule](Update-AzCustomLocationResourceSyncRule.md) +Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name. + diff --git a/src/CustomLocation/CustomLocation/help/Find-AzCustomLocationTargetResourceGroup.md b/src/CustomLocation/CustomLocation/help/Find-AzCustomLocationTargetResourceGroup.md index 99c786806873..de79c6a7c32b 100644 --- a/src/CustomLocation/CustomLocation/help/Find-AzCustomLocationTargetResourceGroup.md +++ b/src/CustomLocation/CustomLocation/help/Find-AzCustomLocationTargetResourceGroup.md @@ -15,28 +15,29 @@ Returns the target resource group associated with the resource sync rules of the ### FindExpanded (Default) ``` Find-AzCustomLocationTargetResourceGroup -CustomLocationName -ResourceGroupName - [-SubscriptionId ] [-Label ] [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-Label ] [-DefaultProfile ] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### FindViaJsonString ``` Find-AzCustomLocationTargetResourceGroup -CustomLocationName -ResourceGroupName - [-SubscriptionId ] -JsonString [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### FindViaJsonFilePath ``` Find-AzCustomLocationTargetResourceGroup -CustomLocationName -ResourceGroupName - [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-PassThru] [-WhatIf] - [-Confirm] [] + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### FindViaIdentityExpanded ``` Find-AzCustomLocationTargetResourceGroup -InputObject [-Label ] - [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -44,24 +45,36 @@ Returns the target resource group associated with the resource sync rules of the ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request. +```powershell Find-AzCustomLocationTargetResourceGroup -ResourceGroupName azps_test_cluster -CustomLocationName azps-customlocation -Label @{"Key1"="Value1"} -PassThru ``` -### EXAMPLE 2 +```output +True ``` + +Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request. + +### Example 2: Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request. +```powershell $obj = Get-AzCustomLocation -ResourceGroupName azps_test_cluster -Name azps-customlocation Find-AzCustomLocationTargetResourceGroup -InputObject $obj -Label @{"Key1"="Value1"} -PassThru ``` +```output +True +``` + +Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request. + ## PARAMETERS ### -CustomLocationName Custom Locations name. ```yaml -Type: String +Type: System.String Parameter Sets: FindExpanded, FindViaJsonString, FindViaJsonFilePath Aliases: @@ -77,7 +90,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -90,10 +103,9 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: ICustomLocationIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity Parameter Sets: FindViaIdentityExpanded Aliases: @@ -108,7 +120,7 @@ Accept wildcard characters: False Path of Json file supplied to the Find operation ```yaml -Type: String +Type: System.String Parameter Sets: FindViaJsonFilePath Aliases: @@ -123,7 +135,7 @@ Accept wildcard characters: False Json string supplied to the Find operation ```yaml -Type: String +Type: System.String Parameter Sets: FindViaJsonString Aliases: @@ -138,7 +150,7 @@ Accept wildcard characters: False Labels of the custom resource, this is a map of {key,value} pairs. ```yaml -Type: Hashtable +Type: System.Collections.Hashtable Parameter Sets: FindExpanded, FindViaIdentityExpanded Aliases: @@ -153,13 +165,28 @@ Accept wildcard characters: False Returns true when the command succeeds ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -169,7 +196,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: FindExpanded, FindViaJsonString, FindViaJsonFilePath Aliases: @@ -184,13 +211,13 @@ Accept wildcard characters: False The ID of the target subscription. ```yaml -Type: String +Type: System.String Parameter Sets: FindExpanded, FindViaJsonString, FindViaJsonFilePath Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -199,7 +226,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -215,7 +242,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -232,24 +259,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationFindTargetResourceGroupResult -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[ChildResourceName \\]: Resource Sync Rule name. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: Custom Locations name. - \[SubscriptionId \\]: The ID of the target subscription. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.customlocation/find-azcustomlocationtargetresourcegroup](https://learn.microsoft.com/powershell/module/az.customlocation/find-azcustomlocationtargetresourcegroup) - diff --git a/src/CustomLocation/CustomLocation/help/Get-AzCustomLocation.md b/src/CustomLocation/CustomLocation/help/Get-AzCustomLocation.md index d817bb03ba6b..a07b3ed3ee06 100644 --- a/src/CustomLocation/CustomLocation/help/Get-AzCustomLocation.md +++ b/src/CustomLocation/CustomLocation/help/Get-AzCustomLocation.md @@ -14,24 +14,26 @@ Gets the details of the customLocation with a specified resource group and name. ### List (Default) ``` -Get-AzCustomLocation [-SubscriptionId ] [-DefaultProfile ] [] +Get-AzCustomLocation [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzCustomLocation -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List1 ``` Get-AzCustomLocation -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzCustomLocation -InputObject [-DefaultProfile ] [] +Get-AzCustomLocation -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -45,56 +47,44 @@ Get-AzCustomLocation ``` ```output -Location Name Namespace --------- ---- ---- -eastus azps_test_cluster arc +Location Name Namespace ResourceGroupName +-------- ---- --------- ----------------- +eastus azps-customlocation azps-namespace azps_test_cluster ``` List the details of the customLocation. ### Example 2: List the details of the customLocation with a specified resource group. ```powershell -Get-AzCustomLocation -ResourceGroupName azps_test_group +Get-AzCustomLocation -ResourceGroupName azps_test_cluster ``` ```output -Location Name Namespace --------- ---- ---- -eastus azps_test_cluster arc +Location Name Namespace ResourceGroupName +-------- ---- --------- ----------------- +eastus azps-customlocation azps-namespace azps_test_cluster ``` List the details of the customLocation with a specified resource group. ### Example 3: Gets the details of the customLocation with a specified resource group and name. ```powershell -Get-AzCustomLocation -ResourceGroupName azps_test_group -Name azps_test_cluster +Get-AzCustomLocation -ResourceGroupName azps_test_cluster -Name azps-customlocation ``` ```output -Location Name Namespace --------- ---- ---- -eastus azps_test_cluster arc +Location Name Namespace ResourceGroupName +-------- ---- --------- ----------------- +eastus azps-customlocation azps-namespace azps_test_cluster ``` Gets the details of the customLocation with a specified resource group and name. -### Example 4: Gets the details of the customLocation. -```powershell -New-AzCustomLocation -ResourceGroupName azps_test_group -Name azps_test_cluster -Location eastus -ClusterExtensionId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/azps_test_group/providers/Microsoft.Kubernetes/connectedClusters/azps_test_cluster/providers/Microsoft.KubernetesConfiguration/extensions/azps_test_extension" -HostResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/azps_test_group/providers/Microsoft.Kubernetes/connectedClusters/azps_test_cluster" -Namespace arc | Get-AzCustomLocation -``` - -```output -Location Name Namespace --------- ---- ---- -eastus azps_test_cluster arc -``` - -Gets the details of the customLocation. - ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -110,7 +100,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity @@ -139,6 +128,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -179,21 +183,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.Api20210815.ICustomLocation +### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocation ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -INPUTOBJECT ``: Identity Parameter - - `[Id ]`: Resource identity path - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceName ]`: Custom Locations name. - - `[SubscriptionId ]`: The ID of the target subscription. - ## RELATED LINKS diff --git a/src/CustomLocation/CustomLocation/help/Get-AzCustomLocationEnabledResourceType.md b/src/CustomLocation/CustomLocation/help/Get-AzCustomLocationEnabledResourceType.md index e6b3b965311a..f3cbaded130f 100644 --- a/src/CustomLocation/CustomLocation/help/Get-AzCustomLocationEnabledResourceType.md +++ b/src/CustomLocation/CustomLocation/help/Get-AzCustomLocationEnabledResourceType.md @@ -14,7 +14,7 @@ Gets the list of the Enabled Resource Types. ``` Get-AzCustomLocationEnabledResourceType -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -28,9 +28,9 @@ Get-AzCustomLocationEnabledResourceType -ResourceGroupName azps_test_group -Name ``` ```output -Name Type ----- ---- -017e563408cfcbaad0604875fef1f0e5a36d5fefa5e81a4c1c212c5a77fbcbde Microsoft.ExtendedLocation/customLocations/enabledResourceTypes +Name ExtensionType +---- ------------- +435b5e8926f937f7a473d48f25731707c20916dfb52a47e0401a40181cb28217 microsoft.arcdataservices ``` Gets the list of the Enabled Resource Types. @@ -38,7 +38,8 @@ Gets the list of the Enabled Resource Types. ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -67,6 +68,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -105,10 +121,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.Api20210815.IEnabledResourceType +### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.IEnabledResourceType ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/CustomLocation/CustomLocation/help/Get-AzCustomLocationResourceSyncRule.md b/src/CustomLocation/CustomLocation/help/Get-AzCustomLocationResourceSyncRule.md index fc175eb4ad30..108e8b4e35ea 100644 --- a/src/CustomLocation/CustomLocation/help/Get-AzCustomLocationResourceSyncRule.md +++ b/src/CustomLocation/CustomLocation/help/Get-AzCustomLocationResourceSyncRule.md @@ -15,25 +15,27 @@ Gets the details of the resourceSyncRule with a specified resource group, subscr ### List (Default) ``` Get-AzCustomLocationResourceSyncRule -CustomLocationName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### Get ``` Get-AzCustomLocationResourceSyncRule -CustomLocationName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentityCustomlocation ``` Get-AzCustomLocationResourceSyncRule -Name -CustomlocationInputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` Get-AzCustomLocationResourceSyncRule -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -41,24 +43,39 @@ Gets the details of the resourceSyncRule with a specified resource group, subscr ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List Resource Sync Rule by Custom Location name. +```powershell Get-AzCustomLocationResourceSyncRule -ResourceGroupName azps_test_cluster -CustomLocationName azps-customlocation ``` -### EXAMPLE 2 +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps-resourcesyncrule azps_test_cluster ``` + +List Resource Sync Rule by Custom Location name. + +### Example 2: Get the detail of the resourceSyncRule with a specified resource group, subscription id Custom Location resource name and Resource Sync Rule name. +```powershell Get-AzCustomLocationResourceSyncRule -ResourceGroupName azps_test_cluster -CustomLocationName azps-customlocation -Name azps-resourcesyncrule ``` +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps-resourcesyncrule azps_test_cluster +``` + +Get the detail of the resourceSyncRule with a specified resource group, subscription id Custom Location resource name and Resource Sync Rule name. + ## PARAMETERS ### -CustomlocationInputObject Identity Parameter -To construct, see NOTES section for CUSTOMLOCATIONINPUTOBJECT properties and create a hash table. ```yaml -Type: ICustomLocationIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity Parameter Sets: GetViaIdentityCustomlocation Aliases: @@ -73,7 +90,7 @@ Accept wildcard characters: False Custom Locations name. ```yaml -Type: String +Type: System.String Parameter Sets: List, Get Aliases: @@ -89,7 +106,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -102,10 +119,9 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: ICustomLocationIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity Parameter Sets: GetViaIdentity Aliases: @@ -120,7 +136,7 @@ Accept wildcard characters: False Resource Sync Rule name. ```yaml -Type: String +Type: System.String Parameter Sets: Get, GetViaIdentityCustomlocation Aliases: @@ -131,12 +147,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: List, Get Aliases: @@ -151,13 +182,13 @@ Accept wildcard characters: False The ID of the target subscription. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: List, Get Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -168,32 +199,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.IResourceSyncRule -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -CUSTOMLOCATIONINPUTOBJECT \: Identity Parameter - \[ChildResourceName \\]: Resource Sync Rule name. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: Custom Locations name. - \[SubscriptionId \\]: The ID of the target subscription. - -INPUTOBJECT \: Identity Parameter - \[ChildResourceName \\]: Resource Sync Rule name. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: Custom Locations name. - \[SubscriptionId \\]: The ID of the target subscription. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.customlocation/get-azcustomlocationresourcesyncrule](https://learn.microsoft.com/powershell/module/az.customlocation/get-azcustomlocationresourcesyncrule) - diff --git a/src/CustomLocation/CustomLocation/help/New-AzCustomLocation.md b/src/CustomLocation/CustomLocation/help/New-AzCustomLocation.md index a18c5cb06d3d..74109d743ba6 100644 --- a/src/CustomLocation/CustomLocation/help/New-AzCustomLocation.md +++ b/src/CustomLocation/CustomLocation/help/New-AzCustomLocation.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzCustomLocation ## SYNOPSIS -Creates or updates a Custom Location in the specified Subscription and Resource Group +Create a Custom Location in the specified Subscription and Resource Group ## SYNTAX @@ -17,39 +17,43 @@ Creates or updates a Custom Location in the specified Subscription and Resource New-AzCustomLocation -Name -ResourceGroupName [-SubscriptionId ] -Location -ClusterExtensionId -HostResourceId -Namespace [-AuthenticationType ] [-AuthenticationValue ] [-DisplayName ] [-IdentityType ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaJsonFilePath ``` New-AzCustomLocation -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzCustomLocation -Name -ResourceGroupName [-SubscriptionId ] -JsonString - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -Creates or updates a Custom Location in the specified Subscription and Resource Group +Create a Custom Location in the specified Subscription and Resource Group ## EXAMPLES -### Example 1: Creates or updates a Custom Location in the specified Subscription and Resource Group +### Example 1: Creates or updates a Custom Location in the specified Subscription and Resource Group. ```powershell -New-AzCustomLocation -ResourceGroupName azps_test_group -Name azps_test_cluster -Location eastus -ClusterExtensionId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/azps_test_group/providers/Microsoft.Kubernetes/connectedClusters/azps_test_cluster/providers/Microsoft.KubernetesConfiguration/extensions/azps_test_extension" -HostResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/azps_test_group/providers/Microsoft.Kubernetes/connectedClusters/azps_test_cluster" -Namespace arc +$HostResourceId = (Get-AzConnectedKubernetes -ClusterName azps-connect -ResourceGroupName azps_test_cluster).Id +$ClusterExtensionId = (Get-AzKubernetesExtension -ClusterName azps-connect -ClusterType ConnectedClusters -ResourceGroupName azps_test_cluster -Name azps-extension).Id +New-AzCustomLocation -ResourceGroupName azps_test_cluster -Name azps-customlocation -Location eastus -ClusterExtensionId $ClusterExtensionId -HostResourceId $HostResourceId -Namespace azps-namespace ``` ```output -Location Name Namespace --------- ---- ---- -eastus azps_test_cluster arc +Location Name Namespace ResourceGroupName +-------- ---- --------- ----------------- +eastus azps-customlocation azps-namespace azps_test_cluster ``` -Creates or updates a Custom Location in the specified Subscription and Resource Group +Creates or updates a Custom Location in the specified Subscription and Resource Group. ## PARAMETERS @@ -114,7 +118,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -264,6 +269,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -346,12 +366,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.Api20210815.ICustomLocation +### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocation ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/CustomLocation/CustomLocation/help/New-AzCustomLocationMatchExpressionsObject.md b/src/CustomLocation/CustomLocation/help/New-AzCustomLocationMatchExpressionsObject.md index f28612fca828..370cf93f46f1 100644 --- a/src/CustomLocation/CustomLocation/help/New-AzCustomLocationMatchExpressionsObject.md +++ b/src/CustomLocation/CustomLocation/help/New-AzCustomLocationMatchExpressionsObject.md @@ -14,7 +14,7 @@ Create an in-memory object for MatchExpressionsProperties. ``` New-AzCustomLocationMatchExpressionsObject [-Key ] [-Operator ] [-Value ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -22,18 +22,26 @@ Create an in-memory object for MatchExpressionsProperties. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create an in-memory object for MatchExpressionsProperties. +```powershell New-AzCustomLocationMatchExpressionsObject -Key "key4" -Operator "In" -Value "value4" ``` +```output +Key Operator +--- -------- +key4 In +``` + +Create an in-memory object for MatchExpressionsProperties. + ## PARAMETERS ### -Key Key is the label key that the selector applies to. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -49,7 +57,7 @@ The Operator field represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -60,11 +68,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Value The label value. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -83,9 +106,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.MatchExpressionsProperties + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/Az.CustomLocation/new-azcustomlocationmatchexpressionsobject](https://learn.microsoft.com/powershell/module/Az.CustomLocation/new-azcustomlocationmatchexpressionsobject) - diff --git a/src/CustomLocation/CustomLocation/help/New-AzCustomLocationResourceSyncRule.md b/src/CustomLocation/CustomLocation/help/New-AzCustomLocationResourceSyncRule.md index e054980648c9..05c7f01a4405 100644 --- a/src/CustomLocation/CustomLocation/help/New-AzCustomLocationResourceSyncRule.md +++ b/src/CustomLocation/CustomLocation/help/New-AzCustomLocationResourceSyncRule.md @@ -17,22 +17,22 @@ Create a Resource Sync Rule in the parent Custom Location, Subscription Id and R New-AzCustomLocationResourceSyncRule -CustomLocationName -Name -ResourceGroupName [-SubscriptionId ] -Location [-Priority ] [-SelectorMatchExpression ] [-SelectorMatchLabel ] - [-Tag ] [-TargetResourceGroup ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] - [-Confirm] [] + [-Tag ] [-TargetResourceGroup ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzCustomLocationResourceSyncRule -CustomLocationName -Name -ResourceGroupName - [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] - [-Confirm] [] + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzCustomLocationResourceSyncRule -CustomLocationName -Name -ResourceGroupName - [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] - [-Confirm] [] + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityCustomlocationExpanded @@ -40,7 +40,8 @@ New-AzCustomLocationResourceSyncRule -CustomLocationName -Name New-AzCustomLocationResourceSyncRule -Name -CustomlocationInputObject -Location [-Priority ] [-SelectorMatchExpression ] [-SelectorMatchLabel ] [-Tag ] [-TargetResourceGroup ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaIdentityExpanded @@ -48,7 +49,8 @@ New-AzCustomLocationResourceSyncRule -Name -CustomlocationInputObject < New-AzCustomLocationResourceSyncRule -InputObject -Location [-Priority ] [-SelectorMatchExpression ] [-SelectorMatchLabel ] [-Tag ] [-TargetResourceGroup ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -56,35 +58,42 @@ Create a Resource Sync Rule in the parent Custom Location, Subscription Id and R ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create a Resource Sync Rule in the parent Custom Location, Subscription Id and Resource Group. +```powershell $MatchExpressions = New-AzCustomLocationMatchExpressionsObject -Key "key4" -Operator "In" -Value "value4" New-AzCustomLocationResourceSyncRule -Name azps-resourcesyncrule -ResourceGroupName azps_test_cluster -CustomLocationName azps-customlocation -Location eastus -Priority 999 -SelectorMatchExpression $MatchExpressions -SelectorMatchLabel @{"Key1"="Value1"} -TargetResourceGroup "/subscriptions/{subId}/resourceGroups/azps_test_cluster" ``` +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps-resourcesyncrule azps_test_cluster +``` + +Create a Resource Sync Rule in the parent Custom Location, Subscription Id and Resource Group. + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -CustomlocationInputObject Identity Parameter -To construct, see NOTES section for CUSTOMLOCATIONINPUTOBJECT properties and create a hash table. ```yaml -Type: ICustomLocationIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity Parameter Sets: CreateViaIdentityCustomlocationExpanded Aliases: @@ -99,7 +108,7 @@ Accept wildcard characters: False Custom Locations name. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: @@ -115,7 +124,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -128,10 +137,9 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: ICustomLocationIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity Parameter Sets: CreateViaIdentityExpanded Aliases: @@ -146,7 +154,7 @@ Accept wildcard characters: False Path of Json file supplied to the Create operation ```yaml -Type: String +Type: System.String Parameter Sets: CreateViaJsonFilePath Aliases: @@ -161,7 +169,7 @@ Accept wildcard characters: False Json string supplied to the Create operation ```yaml -Type: String +Type: System.String Parameter Sets: CreateViaJsonString Aliases: @@ -176,7 +184,7 @@ Accept wildcard characters: False The geo-location where the resource lives ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaIdentityCustomlocationExpanded, CreateViaIdentityExpanded Aliases: @@ -191,7 +199,7 @@ Accept wildcard characters: False Resource Sync Rule name. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, CreateViaIdentityCustomlocationExpanded Aliases: @@ -206,13 +214,13 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -221,13 +229,28 @@ Accept wildcard characters: False Priority represents a priority of the Resource Sync Rule ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: CreateExpanded, CreateViaIdentityCustomlocationExpanded, CreateViaIdentityExpanded Aliases: Required: False Position: Named -Default value: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -237,7 +260,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: @@ -253,10 +276,9 @@ MatchExpressions is a list of resource selector requirements. Valid operators include In, NotIn, Exists, and DoesNotExist. The values set must be non-empty in the case of In and NotIn. The values set must be empty in the case of Exists and DoesNotExist. -To construct, see NOTES section for SELECTORMATCHEXPRESSION properties and create a hash table. ```yaml -Type: IMatchExpressionsProperties[] +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.IMatchExpressionsProperties[] Parameter Sets: CreateExpanded, CreateViaIdentityCustomlocationExpanded, CreateViaIdentityExpanded Aliases: @@ -272,7 +294,7 @@ MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is 'key', the operator is 'In', and the values array contains only 'value'. ```yaml -Type: Hashtable +Type: System.Collections.Hashtable Parameter Sets: CreateExpanded, CreateViaIdentityCustomlocationExpanded, CreateViaIdentityExpanded Aliases: @@ -287,13 +309,13 @@ Accept wildcard characters: False The ID of the target subscription. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -302,7 +324,7 @@ Accept wildcard characters: False Resource tags. ```yaml -Type: Hashtable +Type: System.Collections.Hashtable Parameter Sets: CreateExpanded, CreateViaIdentityCustomlocationExpanded, CreateViaIdentityExpanded Aliases: @@ -319,7 +341,7 @@ If this resource sync rule is one of the matching rules with highest priority, t The user creating this resource sync rule should have write permissions on the target resource group and this write permission will be validated when creating the resource sync rule. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaIdentityCustomlocationExpanded, CreateViaIdentityExpanded Aliases: @@ -334,7 +356,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -350,7 +372,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -367,41 +389,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.IResourceSyncRule -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -CUSTOMLOCATIONINPUTOBJECT \: Identity Parameter - \[ChildResourceName \\]: Resource Sync Rule name. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: Custom Locations name. - \[SubscriptionId \\]: The ID of the target subscription. -INPUTOBJECT \: Identity Parameter - \[ChildResourceName \\]: Resource Sync Rule name. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: Custom Locations name. - \[SubscriptionId \\]: The ID of the target subscription. - -SELECTORMATCHEXPRESSION \: MatchExpressions is a list of resource selector requirements. -Valid operators include In, NotIn, Exists, and DoesNotExist. -The values set must be non-empty in the case of In and NotIn. -The values set must be empty in the case of Exists and DoesNotExist. - \[Key \\]: Key is the label key that the selector applies to. - \[Operator \\]: The Operator field represents a key's relationship to a set of values. -Valid operators are In, NotIn, Exists and DoesNotExist. - \[Value \\>\]: The label value +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.customlocation/new-azcustomlocationresourcesyncrule](https://learn.microsoft.com/powershell/module/az.customlocation/new-azcustomlocationresourcesyncrule) - diff --git a/src/CustomLocation/CustomLocation/help/Remove-AzCustomLocation.md b/src/CustomLocation/CustomLocation/help/Remove-AzCustomLocation.md index 03fb057b3096..df9bdb9e6251 100644 --- a/src/CustomLocation/CustomLocation/help/Remove-AzCustomLocation.md +++ b/src/CustomLocation/CustomLocation/help/Remove-AzCustomLocation.md @@ -15,13 +15,14 @@ Deletes the Custom Location with the specified Resource Name, Resource Group, an ### Delete (Default) ``` Remove-AzCustomLocation -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzCustomLocation -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,14 +32,15 @@ Deletes the Custom Location with the specified Resource Name, Resource Group, an ### Example 1: Deletes the Custom Location. ```powershell -Remove-AzCustomLocation -ResourceGroupName azps_test_group -Name azps_test_cluster +Remove-AzCustomLocation -ResourceGroupName azps_test_cluster -Name azps-customlocation ``` Deletes the Custom Location. ### Example 2: Deletes the Custom Location. ```powershell -Get-AzCustomLocation -ResourceGroupName azps_test_group -Name azps_test_cluster | Remove-AzCustomLocation +$obj = Get-AzCustomLocation -ResourceGroupName azps_test_cluster -Name azps-customlocation +Remove-AzCustomLocation -InputObject $obj ``` Deletes the Custom Location. @@ -61,7 +63,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -77,7 +80,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity @@ -136,6 +138,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -211,17 +228,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -INPUTOBJECT ``: Identity Parameter - - `[Id ]`: Resource identity path - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceName ]`: Custom Locations name. - - `[SubscriptionId ]`: The ID of the target subscription. - ## RELATED LINKS diff --git a/src/CustomLocation/CustomLocation/help/Remove-AzCustomLocationResourceSyncRule.md b/src/CustomLocation/CustomLocation/help/Remove-AzCustomLocationResourceSyncRule.md index f6e501a5ad07..82525ac53444 100644 --- a/src/CustomLocation/CustomLocation/help/Remove-AzCustomLocationResourceSyncRule.md +++ b/src/CustomLocation/CustomLocation/help/Remove-AzCustomLocationResourceSyncRule.md @@ -15,19 +15,21 @@ Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custo ### Delete (Default) ``` Remove-AzCustomLocationResourceSyncRule -CustomLocationName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentityCustomlocation ``` Remove-AzCustomLocationResourceSyncRule -Name -CustomlocationInputObject - [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### DeleteViaIdentity ``` Remove-AzCustomLocationResourceSyncRule -InputObject [-DefaultProfile ] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -35,31 +37,36 @@ Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custo ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custom Location Resource Name, Resource Group, and Subscription Id. +```powershell Remove-AzCustomLocationResourceSyncRule -CustomLocationName azps-customlocation -Name azps-resourcesyncrule -ResourceGroupName azps_test_cluster ``` -### EXAMPLE 2 -``` +Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custom Location Resource Name, Resource Group, and Subscription Id. + +### Example 2: Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custom Location Resource Name, Resource Group, and Subscription Id. +```powershell $obj = Get-AzCustomLocationResourceSyncRule -ResourceGroupName azps_test_cluster -CustomLocationName azps-customlocation -Name azps-resourcesyncrule Remove-AzCustomLocationResourceSyncRule -InputObject $obj ``` -### EXAMPLE 3 -``` +Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custom Location Resource Name, Resource Group, and Subscription Id. + +### Example 3: Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custom Location Resource Name, Resource Group, and Subscription Id. +```powershell $obj = Get-AzCustomLocation -ResourceGroupName azps_test_cluster -Name azps-customlocation Remove-AzCustomLocationResourceSyncRule -CustomlocationInputObject $obj -Name azps-resourcesyncrule ``` +Deletes the Resource Sync Rule with the specified Resource Sync Rule Name, Custom Location Resource Name, Resource Group, and Subscription Id. + ## PARAMETERS ### -CustomlocationInputObject Identity Parameter -To construct, see NOTES section for CUSTOMLOCATIONINPUTOBJECT properties and create a hash table. ```yaml -Type: ICustomLocationIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity Parameter Sets: DeleteViaIdentityCustomlocation Aliases: @@ -74,7 +81,7 @@ Accept wildcard characters: False Custom Locations name. ```yaml -Type: String +Type: System.String Parameter Sets: Delete Aliases: @@ -90,7 +97,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -103,10 +110,9 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: ICustomLocationIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity Parameter Sets: DeleteViaIdentity Aliases: @@ -121,7 +127,7 @@ Accept wildcard characters: False Resource Sync Rule name. ```yaml -Type: String +Type: System.String Parameter Sets: Delete, DeleteViaIdentityCustomlocation Aliases: @@ -136,13 +142,28 @@ Accept wildcard characters: False Returns true when the command succeeds ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -152,7 +173,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: Delete Aliases: @@ -167,13 +188,13 @@ Accept wildcard characters: False The ID of the target subscription. ```yaml -Type: String +Type: System.String Parameter Sets: Delete Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -182,7 +203,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -198,7 +219,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -215,32 +236,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -CUSTOMLOCATIONINPUTOBJECT \: Identity Parameter - \[ChildResourceName \\]: Resource Sync Rule name. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: Custom Locations name. - \[SubscriptionId \\]: The ID of the target subscription. - -INPUTOBJECT \: Identity Parameter - \[ChildResourceName \\]: Resource Sync Rule name. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: Custom Locations name. - \[SubscriptionId \\]: The ID of the target subscription. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.customlocation/remove-azcustomlocationresourcesyncrule](https://learn.microsoft.com/powershell/module/az.customlocation/remove-azcustomlocationresourcesyncrule) - diff --git a/src/CustomLocation/CustomLocation/help/Update-AzCustomLocation.md b/src/CustomLocation/CustomLocation/help/Update-AzCustomLocation.md index bdbfac1127f7..c4f5f639a499 100644 --- a/src/CustomLocation/CustomLocation/help/Update-AzCustomLocation.md +++ b/src/CustomLocation/CustomLocation/help/Update-AzCustomLocation.md @@ -17,19 +17,22 @@ Updates a Custom Location with the specified Resource Name in the specified Reso Update-AzCustomLocation -Name -ResourceGroupName [-SubscriptionId ] [-AuthenticationType ] [-AuthenticationValue ] [-ClusterExtensionId ] [-DisplayName ] [-HostResourceId ] [-IdentityType ] [-Namespace ] - [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-Tag ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonFilePath ``` Update-AzCustomLocation -Name -ResourceGroupName [-SubscriptionId ] - -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] [] + -JsonFilePath [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonString ``` Update-AzCustomLocation -Name -ResourceGroupName [-SubscriptionId ] - -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] [] + -JsonString [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded @@ -37,7 +40,7 @@ Update-AzCustomLocation -Name -ResourceGroupName [-Subscriptio Update-AzCustomLocation -InputObject [-AuthenticationType ] [-AuthenticationValue ] [-ClusterExtensionId ] [-DisplayName ] [-HostResourceId ] [-IdentityType ] [-Namespace ] [-Tag ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -47,26 +50,29 @@ Updates a Custom Location with the specified Resource Name in the specified Reso ### Example 1: Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription. ```powershell -Update-AzCustomLocation -ResourceGroupName azps_test_group -Name azps_test_cluster_1 -ClusterExtensionId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/azps_test_group/providers/Microsoft.Kubernetes/connectedClusters/azps_test_cluster/providers/Microsoft.KubernetesConfiguration/extensions/azps_test_extension" -HostResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/azps_test_group/providers/Microsoft.Kubernetes/connectedClusters/azps_test_cluster" -Namespace arc +$HostResourceId = (Get-AzConnectedKubernetes -ClusterName azps-connect -ResourceGroupName azps_test_cluster).Id +$ClusterExtensionId = (Get-AzKubernetesExtension -ClusterName azps-connect -ClusterType ConnectedClusters -ResourceGroupName azps_test_cluster -Name azps-extension).Id +Update-AzCustomLocation -ResourceGroupName azps_test_cluster -Name azps-customlocation -ClusterExtensionId $ClusterExtensionId -HostResourceId $HostResourceId -Namespace azps-namespace -Tag @{"Key1"="Value1"} ``` ```output -Location Name Namespace --------- ---- ---- -eastus azps_test_cluster_1 arc +Location Name Namespace ResourceGroupName +-------- ---- --------- ----------------- +eastus azps-customlocation azps-namespace azps_test_cluster ``` Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription. ### Example 2: Updates a Custom Location. ```powershell -Get-AzCustomLocation -ResourceGroupName azps_test_group -Name azps_test_cluster | Update-AzCustomLocation +$obj = Get-AzCustomLocation -ResourceGroupName azps_test_cluster -Name azps-customlocation +Update-AzCustomLocation -InputObject $obj -Tag @{"Key1"="Value1"} ``` ```output -Location Name Namespace --------- ---- ---- -eastus azps_test_cluster_1 arc +Location Name Namespace ResourceGroupName +-------- ---- --------- ----------------- +eastus azps-customlocation azps-namespace azps_test_cluster ``` Updates a Custom Location. @@ -119,7 +125,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -255,6 +262,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -341,21 +363,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.Api20210815.ICustomLocation +### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocation ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -INPUTOBJECT ``: Identity Parameter - - `[Id ]`: Resource identity path - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ResourceName ]`: Custom Locations name. - - `[SubscriptionId ]`: The ID of the target subscription. - ## RELATED LINKS diff --git a/src/CustomLocation/CustomLocation/help/Update-AzCustomLocationResourceSyncRule.md b/src/CustomLocation/CustomLocation/help/Update-AzCustomLocationResourceSyncRule.md index 1e59bba78415..006556b1b9fc 100644 --- a/src/CustomLocation/CustomLocation/help/Update-AzCustomLocationResourceSyncRule.md +++ b/src/CustomLocation/CustomLocation/help/Update-AzCustomLocationResourceSyncRule.md @@ -17,21 +17,22 @@ Updates a Resource Sync Rule with the specified Resource Sync Rule name in the s Update-AzCustomLocationResourceSyncRule -CustomLocationName -Name -ResourceGroupName [-SubscriptionId ] [-Priority ] [-SelectorMatchExpression ] [-SelectorMatchLabel ] [-Tag ] [-TargetResourceGroup ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaJsonString ``` Update-AzCustomLocationResourceSyncRule -CustomLocationName -Name -ResourceGroupName - [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] - [-Confirm] [] + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaJsonFilePath ``` Update-AzCustomLocationResourceSyncRule -CustomLocationName -Name -ResourceGroupName - [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] - [-Confirm] [] + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityCustomlocationExpanded @@ -39,15 +40,16 @@ Update-AzCustomLocationResourceSyncRule -CustomLocationName -Name -CustomlocationInputObject [-Priority ] [-SelectorMatchExpression ] [-SelectorMatchLabel ] [-Tag ] [-TargetResourceGroup ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzCustomLocationResourceSyncRule -InputObject [-Priority ] [-SelectorMatchExpression ] [-SelectorMatchLabel ] - [-Tag ] [-TargetResourceGroup ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] - [-Confirm] [] + [-Tag ] [-TargetResourceGroup ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -55,49 +57,72 @@ Updates a Resource Sync Rule with the specified Resource Sync Rule name in the s ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name. +```powershell $MatchExpressions = New-AzCustomLocationMatchExpressionsObject -Key "key4" -Operator "In" -Value "value4" Update-AzCustomLocationResourceSyncRule -Name azps-resourcesyncrule -ResourceGroupName azps_test_cluster -CustomLocationName azps-customlocation -Priority 999 -SelectorMatchExpression $MatchExpressions -SelectorMatchLabel @{"Key1"="Value1"} -TargetResourceGroup "/subscriptions/{subId}/resourceGroups/azps_test_cluster" -Tag @{"abc"="123"} ``` -### EXAMPLE 2 +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps-resourcesyncrule azps_test_cluster ``` + +Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name. + +### Example 2: Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name. +```powershell $MatchExpressions = New-AzCustomLocationMatchExpressionsObject -Key "key4" -Operator "In" -Value "value4" $obj = Get-AzCustomLocationResourceSyncRule -ResourceGroupName azps_test_cluster -CustomLocationName azps-customlocation -Name azps-resourcesyncrule Update-AzCustomLocationResourceSyncRule -InputObject $obj -Priority 999 -SelectorMatchExpression $MatchExpressions -SelectorMatchLabel @{"Key1"="Value1"} -TargetResourceGroup "/subscriptions/{subId}/resourceGroups/azps_test_cluster" -Tag @{"abc"="123"} ``` -### EXAMPLE 3 +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps-resourcesyncrule azps_test_cluster ``` + +Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name. + +### Example 3: Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name. +```powershell $MatchExpressions = New-AzCustomLocationMatchExpressionsObject -Key "key4" -Operator "In" -Value "value4" $obj = Get-AzCustomLocation -ResourceGroupName azps_test_cluster -Name azps-customlocation Update-AzCustomLocationResourceSyncRule -CustomlocationInputObject $obj -Name azps-resourcesyncrule -Priority 999 -SelectorMatchExpression $MatchExpressions -SelectorMatchLabel @{"Key1"="Value1"} -TargetResourceGroup "/subscriptions/{subId}/resourceGroups/azps_test_cluster" -Tag @{"abc"="123"} ``` +```output +Location Name ResourceGroupName +-------- ---- ----------------- +eastus azps-resourcesyncrule azps_test_cluster +``` + +Updates a Resource Sync Rule with the specified Resource Sync Rule name in the specified Resource Group, Subscription and Custom Location name. + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -CustomlocationInputObject Identity Parameter -To construct, see NOTES section for CUSTOMLOCATIONINPUTOBJECT properties and create a hash table. ```yaml -Type: ICustomLocationIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity Parameter Sets: UpdateViaIdentityCustomlocationExpanded Aliases: @@ -112,7 +137,7 @@ Accept wildcard characters: False Custom Locations name. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: @@ -128,7 +153,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -141,10 +166,9 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: ICustomLocationIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity Parameter Sets: UpdateViaIdentityExpanded Aliases: @@ -159,7 +183,7 @@ Accept wildcard characters: False Path of Json file supplied to the Update operation ```yaml -Type: String +Type: System.String Parameter Sets: UpdateViaJsonFilePath Aliases: @@ -174,7 +198,7 @@ Accept wildcard characters: False Json string supplied to the Update operation ```yaml -Type: String +Type: System.String Parameter Sets: UpdateViaJsonString Aliases: @@ -189,7 +213,7 @@ Accept wildcard characters: False Resource Sync Rule name. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityCustomlocationExpanded Aliases: @@ -204,13 +228,13 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -219,13 +243,28 @@ Accept wildcard characters: False Priority represents a priority of the Resource Sync Rule ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: UpdateExpanded, UpdateViaIdentityCustomlocationExpanded, UpdateViaIdentityExpanded Aliases: Required: False Position: Named -Default value: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -235,7 +274,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: @@ -251,10 +290,9 @@ MatchExpressions is a list of resource selector requirements. Valid operators include In, NotIn, Exists, and DoesNotExist. The values set must be non-empty in the case of In and NotIn. The values set must be empty in the case of Exists and DoesNotExist. -To construct, see NOTES section for SELECTORMATCHEXPRESSION properties and create a hash table. ```yaml -Type: IMatchExpressionsProperties[] +Type: Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.IMatchExpressionsProperties[] Parameter Sets: UpdateExpanded, UpdateViaIdentityCustomlocationExpanded, UpdateViaIdentityExpanded Aliases: @@ -270,7 +308,7 @@ MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is 'key', the operator is 'In', and the values array contains only 'value'. ```yaml -Type: Hashtable +Type: System.Collections.Hashtable Parameter Sets: UpdateExpanded, UpdateViaIdentityCustomlocationExpanded, UpdateViaIdentityExpanded Aliases: @@ -285,13 +323,13 @@ Accept wildcard characters: False The ID of the target subscription. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -300,7 +338,7 @@ Accept wildcard characters: False Resource tags ```yaml -Type: Hashtable +Type: System.Collections.Hashtable Parameter Sets: UpdateExpanded, UpdateViaIdentityCustomlocationExpanded, UpdateViaIdentityExpanded Aliases: @@ -317,7 +355,7 @@ If this resource sync rule is one of the matching rules with highest priority, t The user creating this resource sync rule should have write permissions on the target resource group and this write permission will be validated when creating the resource sync rule. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaIdentityCustomlocationExpanded, UpdateViaIdentityExpanded Aliases: @@ -332,7 +370,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -348,7 +386,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -365,41 +403,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.ICustomLocationIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.CustomLocation.Models.IResourceSyncRule -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -CUSTOMLOCATIONINPUTOBJECT \: Identity Parameter - \[ChildResourceName \\]: Resource Sync Rule name. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: Custom Locations name. - \[SubscriptionId \\]: The ID of the target subscription. - -INPUTOBJECT \: Identity Parameter - \[ChildResourceName \\]: Resource Sync Rule name. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ResourceName \\]: Custom Locations name. - \[SubscriptionId \\]: The ID of the target subscription. - -SELECTORMATCHEXPRESSION \: MatchExpressions is a list of resource selector requirements. -Valid operators include In, NotIn, Exists, and DoesNotExist. -The values set must be non-empty in the case of In and NotIn. -The values set must be empty in the case of Exists and DoesNotExist. - \[Key \\]: Key is the label key that the selector applies to. - \[Operator \\]: The Operator field represents a key's relationship to a set of values. -Valid operators are In, NotIn, Exists and DoesNotExist. - \[Value \\>\]: The label value +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.customlocation/update-azcustomlocationresourcesyncrule](https://learn.microsoft.com/powershell/module/az.customlocation/update-azcustomlocationresourcesyncrule) - diff --git a/src/Fleet/Fleet/help/Az.Fleet.md b/src/Fleet/Fleet/help/Az.Fleet.md index e14e8b753d10..9096a1ebbe03 100644 --- a/src/Fleet/Fleet/help/Az.Fleet.md +++ b/src/Fleet/Fleet/help/Az.Fleet.md @@ -63,7 +63,7 @@ Starts an UpdateRun. Stops an UpdateRun. ### [Update-AzFleet](Update-AzFleet.md) -Update a Fleet +Create a Fleet. ### [Update-AzFleetMember](Update-AzFleetMember.md) Update a FleetMember diff --git a/src/Fleet/Fleet/help/Get-AzFleet.md b/src/Fleet/Fleet/help/Get-AzFleet.md index 38570b62f1b5..1dd45b882c9b 100644 --- a/src/Fleet/Fleet/help/Get-AzFleet.md +++ b/src/Fleet/Fleet/help/Get-AzFleet.md @@ -14,31 +14,26 @@ Gets a Fleet. ### List (Default) ``` -Get-AzFleet [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzFleet [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### Get ``` Get-AzFleet -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List1 ``` -Get-AzFleet -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzFleet -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzFleet -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzFleet -InputObject [-DefaultProfile ] [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -46,32 +41,51 @@ Gets a Fleet. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Lists the Fleet resources in a subscription +```powershell Get-AzFleet ``` -### EXAMPLE 2 -``` -Get-AzFleet -Name testfleet01 -ResourceGroupName K8sFleet-Test +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ETag ResourceGroupName +-------- ---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- ----------------- +eastus sss 11/14/2023 8:05:54 AM user1@example.com User 11/14/2023 8:05:54 AM user1@example.com User "25052d24-0000-0100-0000-65532a620000" ps1-test +eastus ttt 11/14/2023 9:55:13 AM user1@example.com User 11/14/2023 9:55:13 AM user1@example.com User "29054cbc-0000-0100-0000-655344020000" ps1-test ``` -## PARAMETERS +This command lists the Fleet resources in a subscription. -### -Break -Wait for .NET debugger to attach +### Example 2: Get specific fleet with specified name +```powershell +Get-AzFleet -Name testfleet01 -ResourceGroupName K8sFleet-Test +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +```output +ETag : "61052549-0000-0100-0000-65542ab10000" +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01 +IdentityPrincipalId : +IdentityTenantId : +IdentityType : +IdentityUserAssignedIdentity : { + } +Location : eastus +Name : testfleet01 +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +SystemDataCreatedAt : 11/15/2023 2:19:28 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/15/2023 2:19:28 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Tag : { + } +Type : Microsoft.ContainerService/fleets +``` + +This command gets specific fleet with specified name. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -89,39 +103,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -150,28 +133,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -180,21 +148,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -221,7 +174,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -232,26 +185,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleet -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/get-azfleet](https://learn.microsoft.com/powershell/module/az.fleet/get-azfleet) - diff --git a/src/Fleet/Fleet/help/Get-AzFleetCredentials.md b/src/Fleet/Fleet/help/Get-AzFleetCredentials.md index 688e95ab516a..53ec1a7f29d8 100644 --- a/src/Fleet/Fleet/help/Get-AzFleetCredentials.md +++ b/src/Fleet/Fleet/help/Get-AzFleetCredentials.md @@ -14,9 +14,7 @@ Lists the user credentials of a Fleet. ``` Get-AzFleetCredentials -FleetName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -24,27 +22,14 @@ Lists the user credentials of a Fleet. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List the user credentials of a Fleet +```powershell Get-AzFleetCredentials -FleetName testfleet01 -ResourceGroupName K8sFleet-Test ``` -## PARAMETERS - -### -Break -Wait for .NET debugger to attach +This command lists the user credentials of a fleet. -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -77,28 +62,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -107,51 +77,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call - -```yaml -Type: System.Management.Automation.PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -178,7 +103,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -222,9 +147,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetCredentialResults + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/get-azfleetcredentials](https://learn.microsoft.com/powershell/module/az.fleet/get-azfleetcredentials) - diff --git a/src/Fleet/Fleet/help/Get-AzFleetMember.md b/src/Fleet/Fleet/help/Get-AzFleetMember.md index 6994eadb61dc..d6bbdec83e97 100644 --- a/src/Fleet/Fleet/help/Get-AzFleetMember.md +++ b/src/Fleet/Fleet/help/Get-AzFleetMember.md @@ -15,31 +15,25 @@ Get a FleetMember ### List (Default) ``` Get-AzFleetMember -FleetName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzFleetMember -FleetName -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentityFleet ``` -Get-AzFleetMember -Name -FleetInputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzFleetMember -Name -FleetInputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzFleetMember -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzFleetMember -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -47,32 +41,47 @@ Get a FleetMember ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Get specific fleet member with specified name +```powershell Get-AzFleetMember -FleetName testfleet01 -ResourceGroupName K8sFleet-Test -Name testmember ``` -### EXAMPLE 2 +```output +ClusterResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/TestCluster01 +ETag : "6205a537-0000-0100-0000-655430760000" +Group : +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/members/testmember +Name : testmember +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +SystemDataCreatedAt : 11/15/2023 2:43:32 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/15/2023 2:43:32 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Type : Microsoft.ContainerService/fleets/members ``` + +This command gets specific fleet member with specified name. + +### Example 2: Get a list of fleet member with specified fleet +```powershell Get-AzFleetMember -FleetName testfleet01 -ResourceGroupName K8sFleet-Test ``` -## PARAMETERS - -### -Break -Wait for .NET debugger to attach +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ETag Resource + GroupNam + e +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- -------- +testmember 11/21/2023 3:13:50 AM user1@example.com User 11/21/2023 3:13:50 AM user1@example.com User "bc061fb4-0000-0100-0000-655c208e0000" K8sFlee… +testmember2 11/21/2023 4:11:24 AM user1@example.com User 11/21/2023 4:11:24 AM user1@example.com User "be067cf2-0000-0100-0000-655c2e280000" K8sFlee… +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +This command gets a list of fleet member with specified fleet. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -92,7 +101,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -121,39 +129,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -182,28 +159,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -212,21 +174,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -253,7 +200,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -264,36 +211,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetMember -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/get-azfleetmember](https://learn.microsoft.com/powershell/module/az.fleet/get-azfleetmember) - diff --git a/src/Fleet/Fleet/help/Get-AzFleetUpdateRun.md b/src/Fleet/Fleet/help/Get-AzFleetUpdateRun.md index b9b564389271..dcb304ed9d28 100644 --- a/src/Fleet/Fleet/help/Get-AzFleetUpdateRun.md +++ b/src/Fleet/Fleet/help/Get-AzFleetUpdateRun.md @@ -15,31 +15,26 @@ Get a UpdateRun ### List (Default) ``` Get-AzFleetUpdateRun -FleetName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzFleetUpdateRun -FleetName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentityFleet ``` -Get-AzFleetUpdateRun -Name -FleetInputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzFleetUpdateRun -Name -FleetInputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzFleetUpdateRun -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzFleetUpdateRun -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -47,32 +42,95 @@ Get a UpdateRun ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Get a list of fleet update run with specified fleet +```powershell Get-AzFleetUpdateRun -FleetName testfleet01 -ResourceGroupName K8sFleet-Test ``` -### EXAMPLE 2 +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ETag ResourceGroupN + ame +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- -------------- +run1 11/21/2023 10:03:56 AM user1@example.com User 11/21/2023 10:03:56 AM user1@example.com User "cb064a93-0000-0100-0000-655c81950000" K8sFleet-Test +run2 11/21/2023 10:10:18 AM user1@example.com User 11/21/2023 10:10:18 AM user1@example.com User "cb0654a8-0000-0100-0000-655c820b0000" K8sFleet-Test ``` + +This command gets a list of fleet update run with specified fleet. + +### Example 2: Get specific fleet update run with specified name +```powershell Get-AzFleetUpdateRun -FleetName testfleet01 -Name run1 -ResourceGroupName K8sFleet-Test ``` -## PARAMETERS - -### -Break -Wait for .NET debugger to attach +```output +AdditionalInfo : +Code : +Detail : +ETag : "cb064a93-0000-0100-0000-655c81950000" +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/updateRuns/run1 +Message : +Name : run1 +NodeImageSelectionSelectedNodeImageVersion : +NodeImageSelectionType : Latest +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +StatusCompletedTime : +StatusStage : {{ + "status": { + "startTime": "2023-11-21T10:07:09.2665585Z", + "state": "Stopping" + }, + "name": "default", + "groups": [ + { + "status": { + "startTime": "2023-11-21T10:07:09.2665583Z", + "state": "Stopping" + }, + "name": "default", + "members": [ + { + "status": { + "startTime": "2023-11-21T10:07:09.2665580Z", + "state": "Running" + }, + "name": "testmember", + "clusterResourceId": + "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/TestCluster01", + "operationId": "50c4e26b-a391-4f7a-9d04-510bcbeda57d", + "message": "all agent pools in managed cluster \"TestCluster01\" are already in the latest node image version" + }, + { + "status": { + "state": "NotStarted" + }, + "name": "testmember2", + "clusterResourceId": + "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/testCluster02" + } + ] + } + ] + }} +StatusStartTime : 11/21/2023 10:07:09 AM +StatusState : Stopping +StrategyStage : +SystemDataCreatedAt : 11/21/2023 10:03:56 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/21/2023 10:03:56 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Target : +Type : Microsoft.ContainerService/fleets/updateRuns +UpdateStrategyId : +UpgradeKubernetesVersion : 1.28.3 +UpgradeType : Full +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +This command gets specific fleet update run with specified name. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -92,7 +150,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -121,39 +178,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -182,28 +208,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -212,21 +223,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -253,7 +249,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -264,36 +260,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IUpdateRun -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/get-azfleetupdaterun](https://learn.microsoft.com/powershell/module/az.fleet/get-azfleetupdaterun) - diff --git a/src/Fleet/Fleet/help/Get-AzFleetUpdateStrategy.md b/src/Fleet/Fleet/help/Get-AzFleetUpdateStrategy.md index 63233143b599..e9cb6bd2e046 100644 --- a/src/Fleet/Fleet/help/Get-AzFleetUpdateStrategy.md +++ b/src/Fleet/Fleet/help/Get-AzFleetUpdateStrategy.md @@ -15,31 +15,26 @@ Get a FleetUpdateStrategy ### List (Default) ``` Get-AzFleetUpdateStrategy -FleetName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzFleetUpdateStrategy -FleetName -Name -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentityFleet ``` Get-AzFleetUpdateStrategy -Name -FleetInputObject [-DefaultProfile ] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzFleetUpdateStrategy -InputObject [-DefaultProfile ] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] +Get-AzFleetUpdateStrategy -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -47,32 +42,54 @@ Get a FleetUpdateStrategy ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Get a list of fleet update strategy with specified fleet +```powershell Get-AzFleetUpdateStrategy -FleetName testfleet01 -ResourceGroupName K8sFleet-Test ``` -### EXAMPLE 2 -``` -Get-AzFleetUpdateStrategy -FleetName testfleet01 -ResourceGroupName K8sFleet-Test -Name strategy1 +```output +Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType ETag ResourceG + roupName +---- ------------------- ------------------- ----------------------- ------------------------ ------------------------ ---------------------------- ---- --------- +strategy1 11/17/2023 9:08:49 AM user1@example.com User 11/17/2023 9:08:49 AM user1@example.com User "fd057996-0000-0100-0000-65572da20000" K8sFleet… +strategy2 11/20/2023 9:36:32 AM user1@example.com User 11/20/2023 9:36:32 AM user1@example.com User "88066ba5-0000-0100-0000-655b28a00000" K8sFleet… +strategy3 11/20/2023 9:40:21 AM user1@example.com User 11/20/2023 9:40:21 AM user1@example.com User "88067ac6-0000-0100-0000-655b29860000" K8sFleet… ``` -## PARAMETERS +This command get a list of fleet update strategy. -### -Break -Wait for .NET debugger to attach +### Example 2: Get a fleet update strategy with specified name +```powershell +Get-AzFleetUpdateStrategy -FleetName testfleet01 -ResourceGroupName K8sFleet-Test -Name strategy1 +``` -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: +```output +ETag : "fd057996-0000-0100-0000-65572da20000" +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/updateStrategies/strategy1 +Name : strategy1 +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +StrategyStage : {{ + "name": "stag1", + "groups": [ + { + "name": "group-a" + } + ], + "afterStageWaitInSeconds": 3600 + }} +SystemDataCreatedAt : 11/17/2023 9:08:49 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/17/2023 9:08:49 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Type : Microsoft.ContainerService/fleets/updateStrategies +``` + +This command gets specific a fleet update strategy with specified update strategy name. -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -DefaultProfile The DefaultProfile parameter is not functional. @@ -92,7 +109,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -121,39 +137,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -182,28 +167,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -212,21 +182,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -253,7 +208,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -264,36 +219,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetUpdateStrategy -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/get-azfleetupdatestrategy](https://learn.microsoft.com/powershell/module/az.fleet/get-azfleetupdatestrategy) - diff --git a/src/Fleet/Fleet/help/New-AzFleet.md b/src/Fleet/Fleet/help/New-AzFleet.md index a133201e2848..443b8cf6c8a6 100644 --- a/src/Fleet/Fleet/help/New-AzFleet.md +++ b/src/Fleet/Fleet/help/New-AzFleet.md @@ -15,34 +15,30 @@ Create a Fleet. ### CreateExpanded (Default) ``` New-AzFleet -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] - [-IfNoneMatch ] -Location [-IdentityType ] [-Tag ] - [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-IfNoneMatch ] -Location [-EnableSystemAssignedIdentity] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzFleet -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] - [-IfNoneMatch ] -JsonString [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-IfNoneMatch ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzFleet -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] - [-IfNoneMatch ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-IfNoneMatch ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityExpanded ``` New-AzFleet -InputObject [-IfMatch ] [-IfNoneMatch ] -Location - [-IdentityType ] [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] - [-AsJob] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] + [-EnableSystemAssignedIdentity] [-Tag ] [-UserAssignedIdentity ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` @@ -51,11 +47,36 @@ Create a Fleet. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Creates a Fleet resource +```powershell New-AzFleet -Name sss -ResourceGroupName ps1-test -Location eastus ``` +```output +ETag : "25052d24-0000-0100-0000-65532a620000" +Id : /subscriptions/'subscriptionId'/resourceGroups/ps1-test/providers/Microsoft.ContainerService/fleets/sss +IdentityPrincipalId : +IdentityTenantId : +IdentityType : +IdentityUserAssignedIdentity : { + } +Location : eastus +Name : sss +ProvisioningState : Succeeded +ResourceGroupName : ps1-test +SystemDataCreatedAt : 11/14/2023 8:05:54 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/14/2023 8:05:54 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Tag : { + } +Type : Microsoft.ContainerService/fleets +``` + +This command creates a Fleet resource with a long running operation. + ## PARAMETERS ### -AsJob @@ -68,22 +89,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -104,41 +110,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IdentityType -Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +### -EnableSystemAssignedIdentity +Decides if enable a system assigned identity for the resource. ```yaml -Type: System.String +Type: System.Management.Automation.SwitchParameter Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: @@ -181,7 +157,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -263,21 +238,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -285,13 +245,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -300,21 +260,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -341,7 +286,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -362,12 +307,11 @@ Accept wildcard characters: False ``` ### -UserAssignedIdentity -The set of user assigned identities associated with the resource. -The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. -The dictionary values can be empty objects ({}) in requests. +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' ```yaml -Type: System.Collections.Hashtable +Type: System.String[] Parameter Sets: CreateExpanded, CreateViaIdentityExpanded Aliases: @@ -415,26 +359,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleet -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/new-azfleet](https://learn.microsoft.com/powershell/module/az.fleet/new-azfleet) - diff --git a/src/Fleet/Fleet/help/New-AzFleetMember.md b/src/Fleet/Fleet/help/New-AzFleetMember.md index 53395bc2a66c..6abb1cd5f824 100644 --- a/src/Fleet/Fleet/help/New-AzFleetMember.md +++ b/src/Fleet/Fleet/help/New-AzFleetMember.md @@ -16,43 +16,36 @@ Create a FleetMember ``` New-AzFleetMember -FleetName -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] -ClusterResourceId [-Group ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaJsonString ``` New-AzFleetMember -FleetName -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] -JsonString [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzFleetMember -FleetName -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] -JsonFilePath [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityFleetExpanded ``` New-AzFleetMember -Name -FleetInputObject [-IfMatch ] [-IfNoneMatch ] - -ClusterResourceId [-Group ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -ClusterResourceId [-Group ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityExpanded ``` New-AzFleetMember -InputObject [-IfMatch ] [-IfNoneMatch ] - -ClusterResourceId [-Group ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -ClusterResourceId [-Group ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -60,11 +53,30 @@ Create a FleetMember ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create a FleetMember +```powershell New-AzFleetMember -FleetName testfleet01 -Name testmember -ResourceGroupName K8sFleet-Test -ClusterResourceId /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/TestCluster01 ``` +```output +ClusterResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/TestCluster01 +ETag : "6205a537-0000-0100-0000-655430760000" +Group : +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/members/testmember +Name : testmember +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +SystemDataCreatedAt : 11/15/2023 2:43:32 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/15/2023 2:43:32 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Type : Microsoft.ContainerService/fleets/members +``` + +This command creates a fleet member with a long running operation. + ## PARAMETERS ### -AsJob @@ -77,22 +89,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -132,7 +129,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -176,36 +172,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IfMatch The request should only proceed if an entity matches this string. @@ -238,7 +204,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -305,21 +270,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -327,13 +277,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -342,21 +292,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -383,7 +318,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -425,36 +360,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetMember -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/new-azfleetmember](https://learn.microsoft.com/powershell/module/az.fleet/new-azfleetmember) - diff --git a/src/Fleet/Fleet/help/New-AzFleetUpdateGroupObject.md b/src/Fleet/Fleet/help/New-AzFleetUpdateGroupObject.md index 0bb472d207cd..aa7e1ee81a71 100644 --- a/src/Fleet/Fleet/help/New-AzFleetUpdateGroupObject.md +++ b/src/Fleet/Fleet/help/New-AzFleetUpdateGroupObject.md @@ -13,7 +13,7 @@ Create an in-memory object for UpdateGroup. ## SYNTAX ``` -New-AzFleetUpdateGroupObject -Name [] +New-AzFleetUpdateGroupObject -Name [-ProgressAction ] [] ``` ## DESCRIPTION @@ -21,11 +21,19 @@ Create an in-memory object for UpdateGroup. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create a fleet update group +```powershell New-AzFleetUpdateGroupObject -Name 'Group-a' ``` +```output +Name +---- +Group-a +``` + +This command create a fleet update group object. + ## PARAMETERS ### -Name @@ -45,6 +53,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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). @@ -53,9 +76,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.UpdateGroup + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/Az.Fleet/new-azfleetupdategroupobject](https://learn.microsoft.com/powershell/module/Az.Fleet/new-azfleetupdategroupobject) - diff --git a/src/Fleet/Fleet/help/New-AzFleetUpdateRun.md b/src/Fleet/Fleet/help/New-AzFleetUpdateRun.md index 25b233a87cf6..c2b1a92fbedc 100644 --- a/src/Fleet/Fleet/help/New-AzFleetUpdateRun.md +++ b/src/Fleet/Fleet/help/New-AzFleetUpdateRun.md @@ -17,27 +17,22 @@ Create a UpdateRun New-AzFleetUpdateRun -FleetName -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] -UpgradeType [-NodeImageSelectionType ] [-StrategyStage ] [-UpdateStrategyId ] [-UpgradeKubernetesVersion ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaJsonString ``` New-AzFleetUpdateRun -FleetName -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] -JsonString [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath ``` New-AzFleetUpdateRun -FleetName -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] -JsonFilePath [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityFleetExpanded @@ -45,9 +40,8 @@ New-AzFleetUpdateRun -FleetName -Name -ResourceGroupName -FleetInputObject [-IfMatch ] [-IfNoneMatch ] -UpgradeType [-NodeImageSelectionType ] [-StrategyStage ] [-UpdateStrategyId ] [-UpgradeKubernetesVersion ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaIdentityExpanded @@ -55,9 +49,7 @@ New-AzFleetUpdateRun -Name -FleetInputObject [-IfMatch New-AzFleetUpdateRun -InputObject [-IfMatch ] [-IfNoneMatch ] -UpgradeType [-NodeImageSelectionType ] [-StrategyStage ] [-UpdateStrategyId ] [-UpgradeKubernetesVersion ] [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -65,11 +57,74 @@ Create a UpdateRun ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create a fleet update run +```powershell New-AzFleetUpdateRun -FleetName testfleet01 -Name run1 -ResourceGroupName K8sFleet-Test -UpgradeType Full -UpgradeKubernetesVersion "1.26.1" -NodeImageSelectionType Latest ``` +```output +AdditionalInfo : +Code : +Detail : +ETag : "cb06884a-0000-0100-0000-655c7fcf0000" +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/updateRuns/run1 +Message : +Name : run1 +NodeImageSelectionSelectedNodeImageVersion : +NodeImageSelectionType : Latest +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +StatusCompletedTime : +StatusStage : {{ + "status": { + "state": "NotStarted" + }, + "name": "default", + "groups": [ + { + "status": { + "state": "NotStarted" + }, + "name": "default", + "members": [ + { + "status": { + "state": "NotStarted" + }, + "name": "testmember", + "clusterResourceId": + "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/TestCluster01" + }, + { + "status": { + "state": "NotStarted" + }, + "name": "testmember2", + "clusterResourceId": + "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/testCluster02" + } + ] + } + ] + }} +StatusStartTime : +StatusState : NotStarted +StrategyStage : +SystemDataCreatedAt : 11/21/2023 10:00:46 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/21/2023 10:00:46 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Target : +Type : Microsoft.ContainerService/fleets/updateRuns +UpdateStrategyId : +UpgradeKubernetesVersion : 1.28.1 +UpgradeType : Full +``` + +This command create a fleet update run. + ## PARAMETERS ### -AsJob @@ -82,22 +137,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -120,7 +160,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -149,36 +188,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IfMatch The request should only proceed if an entity matches this string. @@ -211,7 +220,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -293,21 +301,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -315,13 +308,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -330,21 +323,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -364,7 +342,6 @@ Accept wildcard characters: False ### -StrategyStage The list of stages that compose this update run. Min size: 1. -To construct, see NOTES section for STRATEGYSTAGE properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IUpdateStage[] @@ -388,7 +365,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -482,48 +459,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IUpdateRun -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. -STRATEGYSTAGE \: The list of stages that compose this update run. -Min size: 1. - Name \: The name of the stage. -Must be unique within the UpdateRun. - \[AfterStageWaitInSecond \\]: The time in seconds to wait at the end of this stage before starting the next one. -Defaults to 0 seconds if unspecified. - \[Group \\>\]: Defines the groups to be executed in parallel in this stage. -Duplicate groups are not allowed. -Min size: 1. - Name \: Name of the group. -It must match a group name of an existing fleet member. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/new-azfleetupdaterun](https://learn.microsoft.com/powershell/module/az.fleet/new-azfleetupdaterun) - diff --git a/src/Fleet/Fleet/help/New-AzFleetUpdateStageObject.md b/src/Fleet/Fleet/help/New-AzFleetUpdateStageObject.md index e5b2cc5113fd..6066f58ce7fa 100644 --- a/src/Fleet/Fleet/help/New-AzFleetUpdateStageObject.md +++ b/src/Fleet/Fleet/help/New-AzFleetUpdateStageObject.md @@ -14,7 +14,7 @@ Create an in-memory object for UpdateStage. ``` New-AzFleetUpdateStageObject -Name [-AfterStageWaitInSecond ] [-Group ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -22,19 +22,43 @@ Create an in-memory object for UpdateStage. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: create fleet update stage object with group string array +```powershell New-AzFleetUpdateStageObject -Name stag1 -Group @{name='group-a'} -AfterStageWaitInSecond 3600 | Format-List ``` -### EXAMPLE 2 +```output +AfterStageWaitInSecond : 3600 +Group : {{ + "name": "group-a" + }} +Name : stag1 ``` + +This command create a fleet update stage object and shows as list. + +### Example 2: create fleet update stage object with update group object +```powershell $a = New-AzFleetUpdateGroupObject -Name 'Group-a' $b = New-AzFleetUpdateGroupObject -Name 'Group-b' $c = New-AzFleetUpdateGroupObject -Name 'Group-c' New-AzFleetUpdateStageObject -Name stag1 -Group $a,$b,$c -AfterStageWaitInSecond 3600 | Format-List ``` +```output +AfterStageWaitInSecond : 3600 +Group : {{ + "name": "Group-a" + }, { + "name": "Group-b" + }, { + "name": "Group-c" + }} +Name : stag1 +``` + +This command create a fleet update stage object and shows as list. + ## PARAMETERS ### -AfterStageWaitInSecond @@ -48,7 +72,7 @@ Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -57,7 +81,6 @@ Accept wildcard characters: False Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. -To construct, see NOTES section for GROUP properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IUpdateGroup[] @@ -87,6 +110,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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). @@ -95,19 +133,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.UpdateStage -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -GROUP \: Defines the groups to be executed in parallel in this stage. -Duplicate groups are not allowed. -Min size: 1. - Name \: Name of the group. -It must match a group name of an existing fleet member. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/Az.Fleet/new-azfleetupdatestageobject](https://learn.microsoft.com/powershell/module/Az.Fleet/new-azfleetupdatestageobject) - diff --git a/src/Fleet/Fleet/help/New-AzFleetUpdateStrategy.md b/src/Fleet/Fleet/help/New-AzFleetUpdateStrategy.md index 4c1591cb7204..bd4468971e30 100644 --- a/src/Fleet/Fleet/help/New-AzFleetUpdateStrategy.md +++ b/src/Fleet/Fleet/help/New-AzFleetUpdateStrategy.md @@ -15,44 +15,39 @@ Create a FleetUpdateStrategy ### CreateViaIdentityExpanded (Default) ``` New-AzFleetUpdateStrategy -InputObject [-IfMatch ] [-IfNoneMatch ] - -StrategyStage [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + -StrategyStage [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonString ``` New-AzFleetUpdateStrategy -FleetName -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] -JsonString - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaJsonFilePath ``` New-AzFleetUpdateStrategy -FleetName -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] -JsonFilePath - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateExpanded ``` New-AzFleetUpdateStrategy -FleetName -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] -StrategyStage - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaIdentityFleetExpanded ``` New-AzFleetUpdateStrategy -Name -FleetInputObject [-IfMatch ] - [-IfNoneMatch ] -StrategyStage [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-IfNoneMatch ] -StrategyStage [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -60,19 +55,74 @@ Create a FleetUpdateStrategy ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create a fleet update strategy +```powershell $stage = New-AzFleetUpdateStageObject -Name stag1 -Group @{name='group-a'} -AfterStageWaitInSecond 3600 New-AzFleetUpdateStrategy -FleetName testfleet01 -ResourceGroupName K8sFleet-Test -Name strategy1 -StrategyStage $stage ``` -### EXAMPLE 2 -``` +```output +ETag : "fd057996-0000-0100-0000-65572da20000" +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/updateStrategies/strategy1 +Name : strategy1 +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +StrategyStage : {{ + "name": "stag1", + "groups": [ + { + "name": "group-a" + } + ], + "afterStageWaitInSeconds": 3600 + }} +SystemDataCreatedAt : 11/17/2023 9:08:49 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/17/2023 9:08:49 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Type : Microsoft.ContainerService/fleets/updateStrategies +``` + +The first command creates a fleet update stage object. +The second command creates a fleet update strategy. + +### Example 2: Create a fleet update strategy with a fleet object +```powershell $f = Get-AzFleet -Name testfleet01 -ResourceGroupName K8sFleet-Test $stage2 = New-AzFleetUpdateStageObject -Name stag2 -Group @{name='group-b'} -AfterStageWaitInSecond 3600 New-AzFleetUpdateStrategy -FleetInputObject $f -Name strategy3 -StrategyStage $stage2 ``` +```output +ETag : "88067ac6-0000-0100-0000-655b29860000" +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/updateStrategies/strategy3 +Name : strategy3 +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +StrategyStage : {{ + "name": "stag2", + "groups": [ + { + "name": "group-b" + } + ], + "afterStageWaitInSeconds": 3600 + }} +SystemDataCreatedAt : 11/20/2023 9:40:21 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/20/2023 9:40:21 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Type : Microsoft.ContainerService/fleets/updateStrategies +``` + +The first command get a fleet. +The second command creates a fleet update stage object. +The third command uses fleet resource to create a fleet update strategy. + ## PARAMETERS ### -AsJob @@ -85,22 +135,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -123,7 +158,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -152,36 +186,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IfMatch The request should only proceed if an entity matches this string. @@ -214,7 +218,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -281,21 +284,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -303,13 +291,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -318,21 +306,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -352,7 +325,6 @@ Accept wildcard characters: False ### -StrategyStage The list of stages that compose this update run. Min size: 1. -To construct, see NOTES section for STRATEGYSTAGE properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IUpdateStage[] @@ -376,7 +348,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -418,48 +390,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetUpdateStrategy -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -STRATEGYSTAGE \: The list of stages that compose this update run. -Min size: 1. - Name \: The name of the stage. -Must be unique within the UpdateRun. - \[AfterStageWaitInSecond \\]: The time in seconds to wait at the end of this stage before starting the next one. -Defaults to 0 seconds if unspecified. - \[Group \\>\]: Defines the groups to be executed in parallel in this stage. -Duplicate groups are not allowed. -Min size: 1. - Name \: Name of the group. -It must match a group name of an existing fleet member. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/new-azfleetupdatestrategy](https://learn.microsoft.com/powershell/module/az.fleet/new-azfleetupdatestrategy) - diff --git a/src/Fleet/Fleet/help/Remove-AzFleet.md b/src/Fleet/Fleet/help/Remove-AzFleet.md index 23061da34f41..ed3bc2da7725 100644 --- a/src/Fleet/Fleet/help/Remove-AzFleet.md +++ b/src/Fleet/Fleet/help/Remove-AzFleet.md @@ -15,17 +15,14 @@ Delete a Fleet ### Delete (Default) ``` Remove-AzFleet -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` -Remove-AzFleet -InputObject [-IfMatch ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-PassThru] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] +Remove-AzFleet -InputObject [-IfMatch ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -33,17 +30,21 @@ Delete a Fleet ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete a Fleet +```powershell Remove-AzFleet -Name ttt -ResourceGroupName ps1-test ``` -### EXAMPLE 2 -``` +This command deletes a Fleet resource asynchronously with a long running operation. + +### Example 2: Delete a Fleet +```powershell $f = Get-AzFleet -Name sss -ResourceGroupName ps1-test Remove-AzFleet -InputObject $f ``` +This command deletes a Fleet resource with fleet object. + ## PARAMETERS ### -AsJob @@ -56,22 +57,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -92,36 +78,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IfMatch The request should only proceed if an entity matches this string. @@ -139,7 +95,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -178,7 +133,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -191,21 +146,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -213,13 +153,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -228,21 +168,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -269,7 +194,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -311,26 +236,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/remove-azfleet](https://learn.microsoft.com/powershell/module/az.fleet/remove-azfleet) - diff --git a/src/Fleet/Fleet/help/Remove-AzFleetMember.md b/src/Fleet/Fleet/help/Remove-AzFleetMember.md index c4fa454ec90e..832deaa20acd 100644 --- a/src/Fleet/Fleet/help/Remove-AzFleetMember.md +++ b/src/Fleet/Fleet/help/Remove-AzFleetMember.md @@ -15,25 +15,21 @@ Delete a FleetMember ### Delete (Default) ``` Remove-AzFleetMember -FleetName -Name -ResourceGroupName [-SubscriptionId ] - [-IfMatch ] [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-IfMatch ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentityFleet ``` Remove-AzFleetMember -Name -FleetInputObject [-IfMatch ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzFleetMember -InputObject [-IfMatch ] [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-PassThru] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] - [-Confirm] [] + [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -41,17 +37,21 @@ Delete a FleetMember ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete a fleet member +```powershell Remove-AzFleetMember -FleetName testfleet01 -Name testmember -ResourceGroupName K8sFleet-Test ``` -### EXAMPLE 2 -``` +This command deletes a Fleet member with a long running operation. + +### Example 2: Delete a fleet member +```powershell $m = Get-AzFleetMember -FleetName testfleet01 -ResourceGroupName K8sFleet-Test -Name testmember Remove-AzFleetMember -InputObject $m ``` +This command deletes a Fleet member asynchronously with resource object. + ## PARAMETERS ### -AsJob @@ -64,22 +64,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -102,7 +87,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -131,36 +115,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IfMatch The request should only proceed if an entity matches this string. @@ -178,7 +132,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -217,7 +170,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -230,21 +183,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -252,13 +190,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -267,21 +205,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -308,7 +231,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -350,36 +273,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/remove-azfleetmember](https://learn.microsoft.com/powershell/module/az.fleet/remove-azfleetmember) - diff --git a/src/Fleet/Fleet/help/Remove-AzFleetUpdateRun.md b/src/Fleet/Fleet/help/Remove-AzFleetUpdateRun.md index f7c8a1aa87fd..51a8ca40ce96 100644 --- a/src/Fleet/Fleet/help/Remove-AzFleetUpdateRun.md +++ b/src/Fleet/Fleet/help/Remove-AzFleetUpdateRun.md @@ -15,26 +15,21 @@ Delete a UpdateRun ### Delete (Default) ``` Remove-AzFleetUpdateRun -FleetName -Name -ResourceGroupName - [-SubscriptionId ] [-IfMatch ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-PassThru] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-IfMatch ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentityFleet ``` Remove-AzFleetUpdateRun -Name -FleetInputObject [-IfMatch ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzFleetUpdateRun -InputObject [-IfMatch ] [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-PassThru] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] - [-Confirm] [] + [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -42,11 +37,13 @@ Delete a UpdateRun ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Delete a fleet update run +```powershell Remove-AzFleetUpdateRun -FleetName testfleet01 -Name run2 -ResourceGroupName K8sFleet-Test ``` +This command delete specified fleet update run. + ## PARAMETERS ### -AsJob @@ -59,22 +56,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -97,7 +79,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -126,36 +107,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IfMatch The request should only proceed if an entity matches this string. @@ -173,7 +124,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -212,7 +162,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -225,21 +175,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -247,13 +182,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -262,21 +197,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -303,7 +223,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -345,36 +265,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/remove-azfleetupdaterun](https://learn.microsoft.com/powershell/module/az.fleet/remove-azfleetupdaterun) - diff --git a/src/Fleet/Fleet/help/Remove-AzFleetUpdateStrategy.md b/src/Fleet/Fleet/help/Remove-AzFleetUpdateStrategy.md index 142de7cd3de6..649499fe793d 100644 --- a/src/Fleet/Fleet/help/Remove-AzFleetUpdateStrategy.md +++ b/src/Fleet/Fleet/help/Remove-AzFleetUpdateStrategy.md @@ -15,26 +15,21 @@ Delete a FleetUpdateStrategy ### Delete (Default) ``` Remove-AzFleetUpdateStrategy -FleetName -Name -ResourceGroupName - [-SubscriptionId ] [-IfMatch ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-PassThru] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-IfMatch ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentityFleet ``` Remove-AzFleetUpdateStrategy -Name -FleetInputObject [-IfMatch ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-PassThru] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzFleetUpdateStrategy -InputObject [-IfMatch ] [-DefaultProfile ] - [-AsJob] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-PassThru] [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] - [-Confirm] [] + [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -42,17 +37,22 @@ Delete a FleetUpdateStrategy ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: delete a fleet update strategy with a fleet object +```powershell $f = Get-AzFleet -Name testfleet01 -ResourceGroupName K8sFleet-Test Remove-AzFleetUpdateStrategy -FleetInputObject $f -Name strategy3 ``` -### EXAMPLE 2 -``` +The first command gets a fleet. +The second command removes a fleet update strategy with a fleet object. + +### Example 2: delete a fleet update strategy +```powershell Remove-AzFleetUpdateStrategy -FleetName testfleet01 -ResourceGroupName K8sFleet-Test -Name strategy2 ``` +This command removes a fleet update strategy with name. + ## PARAMETERS ### -AsJob @@ -65,22 +65,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -103,7 +88,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -132,36 +116,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IfMatch The request should only proceed if an entity matches this string. @@ -179,7 +133,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -218,7 +171,7 @@ Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -231,21 +184,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -253,13 +191,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -268,21 +206,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -309,7 +232,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -351,36 +274,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/remove-azfleetupdatestrategy](https://learn.microsoft.com/powershell/module/az.fleet/remove-azfleetupdatestrategy) - diff --git a/src/Fleet/Fleet/help/Start-AzFleetUpdateRun.md b/src/Fleet/Fleet/help/Start-AzFleetUpdateRun.md index 83d1930dcb24..b1882b283398 100644 --- a/src/Fleet/Fleet/help/Start-AzFleetUpdateRun.md +++ b/src/Fleet/Fleet/help/Start-AzFleetUpdateRun.md @@ -15,25 +15,21 @@ Starts an UpdateRun. ### Start (Default) ``` Start-AzFleetUpdateRun -FleetName -Name -ResourceGroupName - [-SubscriptionId ] [-IfMatch ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-SubscriptionId ] [-IfMatch ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### StartViaIdentityFleet ``` Start-AzFleetUpdateRun -Name -FleetInputObject [-IfMatch ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### StartViaIdentity ``` Start-AzFleetUpdateRun -InputObject [-IfMatch ] [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -41,11 +37,74 @@ Starts an UpdateRun. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Start specific fleet update run with specified name +```powershell Start-AzFleetUpdateRun -FleetName testfleet01 -Name run1 -ResourceGroupName K8sFleet-Test ``` +```output +AdditionalInfo : +Code : +Detail : +ETag : "cb067c64-0000-0100-0000-655c808d0000" +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/updateRuns/run1 +Message : +Name : run1 +NodeImageSelectionSelectedNodeImageVersion : +NodeImageSelectionType : Latest +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +StatusCompletedTime : +StatusStage : {{ + "status": { + "state": "NotStarted" + }, + "name": "default", + "groups": [ + { + "status": { + "state": "NotStarted" + }, + "name": "default", + "members": [ + { + "status": { + "state": "NotStarted" + }, + "name": "testmember", + "clusterResourceId": + "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/TestCluster01" + }, + { + "status": { + "state": "NotStarted" + }, + "name": "testmember2", + "clusterResourceId": + "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/testCluster02" + } + ] + } + ] + }} +StatusStartTime : +StatusState : NotStarted +StrategyStage : +SystemDataCreatedAt : 11/21/2023 10:03:56 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/21/2023 10:03:56 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Target : +Type : Microsoft.ContainerService/fleets/updateRuns +UpdateStrategyId : +UpgradeKubernetesVersion : 1.28.3 +UpgradeType : Full +``` + +This command starts specific fleet update run with specified name + ## PARAMETERS ### -AsJob @@ -58,22 +117,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -96,7 +140,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -125,36 +168,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IfMatch The request should only proceed if an entity matches this string. @@ -172,7 +185,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -209,21 +221,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -231,13 +228,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -246,21 +243,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -287,7 +269,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -329,36 +311,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IUpdateRun -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/start-azfleetupdaterun](https://learn.microsoft.com/powershell/module/az.fleet/start-azfleetupdaterun) - diff --git a/src/Fleet/Fleet/help/Stop-AzFleetUpdateRun.md b/src/Fleet/Fleet/help/Stop-AzFleetUpdateRun.md index 2a0cf7cf1941..8cbc1a33e182 100644 --- a/src/Fleet/Fleet/help/Stop-AzFleetUpdateRun.md +++ b/src/Fleet/Fleet/help/Stop-AzFleetUpdateRun.md @@ -15,25 +15,21 @@ Stops an UpdateRun. ### Stop (Default) ``` Stop-AzFleetUpdateRun -FleetName -Name -ResourceGroupName [-SubscriptionId ] - [-IfMatch ] [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-IfMatch ] [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### StopViaIdentityFleet ``` Stop-AzFleetUpdateRun -Name -FleetInputObject [-IfMatch ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### StopViaIdentity ``` Stop-AzFleetUpdateRun -InputObject [-IfMatch ] [-DefaultProfile ] [-AsJob] - [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -41,11 +37,79 @@ Stops an UpdateRun. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Stop specific fleet update run with specified name +```powershell Stop-AzFleetUpdateRun -FleetName testfleet01 -Name run1 -ResourceGroupName K8sFleet-Test ``` +```output +AdditionalInfo : +Code : +Detail : +ETag : "cb064a93-0000-0100-0000-655c81950000" +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/updateRuns/run1 +Message : +Name : run1 +NodeImageSelectionSelectedNodeImageVersion : +NodeImageSelectionType : Latest +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +StatusCompletedTime : +StatusStage : {{ + "status": { + "startTime": "2023-11-21T10:07:09.2665585Z", + "state": "Stopping" + }, + "name": "default", + "groups": [ + { + "status": { + "startTime": "2023-11-21T10:07:09.2665583Z", + "state": "Stopping" + }, + "name": "default", + "members": [ + { + "status": { + "startTime": "2023-11-21T10:07:09.2665580Z", + "state": "Running" + }, + "name": "testmember", + "clusterResourceId": + "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/TestCluster01", + "operationId": "50c4e26b-a391-4f7a-9d04-510bcbeda57d", + "message": "all agent pools in managed cluster \"TestCluster01\" are already in the latest node image version" + }, + { + "status": { + "state": "NotStarted" + }, + "name": "testmember2", + "clusterResourceId": + "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/testCluster02" + } + ] + } + ] + }} +StatusStartTime : 11/21/2023 10:07:09 AM +StatusState : Stopping +StrategyStage : +SystemDataCreatedAt : 11/21/2023 10:03:56 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/21/2023 10:03:56 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Target : +Type : Microsoft.ContainerService/fleets/updateRuns +UpdateStrategyId : +UpgradeKubernetesVersion : 1.28.3 +UpgradeType : Full +``` + +This command stop specific fleet update run with specified name. + ## PARAMETERS ### -AsJob @@ -58,22 +122,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -96,7 +145,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -125,36 +173,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IfMatch The request should only proceed if an entity matches this string. @@ -172,7 +190,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -209,21 +226,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -231,13 +233,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -246,21 +248,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -287,7 +274,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -329,36 +316,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IUpdateRun -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/stop-azfleetupdaterun](https://learn.microsoft.com/powershell/module/az.fleet/stop-azfleetupdaterun) - diff --git a/src/Fleet/Fleet/help/Update-AzFleet.md b/src/Fleet/Fleet/help/Update-AzFleet.md index 014d48918a4b..2861c43fd79c 100644 --- a/src/Fleet/Fleet/help/Update-AzFleet.md +++ b/src/Fleet/Fleet/help/Update-AzFleet.md @@ -8,53 +8,62 @@ schema: 2.0.0 # Update-AzFleet ## SYNOPSIS -Update a Fleet +Create a Fleet. ## SYNTAX ### UpdateExpanded (Default) ``` Update-AzFleet -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] - [-IdentityType ] [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] - [-AsJob] [-Break] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] - [-Proxy ] [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] - [] -``` - -### UpdateViaJsonString -``` -Update-AzFleet -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] - -JsonString [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] -``` - -### UpdateViaJsonFilePath -``` -Update-AzFleet -Name -ResourceGroupName [-SubscriptionId ] [-IfMatch ] - -JsonFilePath [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-IfNoneMatch ] [-EnableSystemAssignedIdentity ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzFleet -InputObject [-IfMatch ] [-IdentityType ] [-Tag ] - [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] +Update-AzFleet -InputObject [-IfMatch ] [-IfNoneMatch ] + [-EnableSystemAssignedIdentity ] [-Tag ] [-UserAssignedIdentity ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -Update a Fleet +Create a Fleet. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update tag of specified fleet +```powershell Update-AzFleet -Name testfleet01 -ResourceGroupName K8sFleet-Test -Tag @{"123"="abc"} ``` +```output +ETag : "cb06f006-0000-0100-0000-655c7e120000" +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01 +IdentityPrincipalId : +IdentityTenantId : +IdentityType : +IdentityUserAssignedIdentity : { + } +Location : eastus +Name : testfleet01 +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +SystemDataCreatedAt : 11/15/2023 2:19:28 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/21/2023 9:53:21 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Tag : { + "123": "abc" + } +Type : Microsoft.ContainerService/fleets +``` + +This command updates tag of a fleet. + ## PARAMETERS ### -AsJob @@ -67,22 +76,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -103,26 +97,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline +### -EnableSystemAssignedIdentity +Decides if enable a system assigned identity for the resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] +Type: System.Nullable`1[System.Boolean] Parameter Sets: (All) Aliases: @@ -133,12 +112,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityType -Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +### -IfMatch +The request should only proceed if an entity matches this string. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: (All) Aliases: Required: False @@ -148,8 +127,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IfMatch -The request should only proceed if an entity matches this string. +### -IfNoneMatch +The request should only proceed if no entity matches this string. ```yaml Type: System.String @@ -165,7 +144,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -179,42 +157,12 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -JsonFilePath -Path of Json file supplied to the Update operation - -```yaml -Type: System.String -Parameter Sets: UpdateViaJsonFilePath -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JsonString -Json string supplied to the Update operation - -```yaml -Type: System.String -Parameter Sets: UpdateViaJsonString -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Name The name of the Fleet resource. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Parameter Sets: UpdateExpanded Aliases: FleetName Required: True @@ -232,21 +180,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -254,13 +187,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -269,28 +202,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -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, UpdateViaJsonString, UpdateViaJsonFilePath +Parameter Sets: UpdateExpanded Aliases: Required: True @@ -305,12 +223,12 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Parameter Sets: UpdateExpanded Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -320,7 +238,7 @@ Resource tags. ```yaml Type: System.Collections.Hashtable -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Parameter Sets: (All) Aliases: Required: False @@ -331,13 +249,12 @@ Accept wildcard characters: False ``` ### -UserAssignedIdentity -The set of user assigned identities associated with the resource. -The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. -The dictionary values can be empty objects ({}) in requests. +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' ```yaml -Type: System.Collections.Hashtable -Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Type: System.String[] +Parameter Sets: (All) Aliases: Required: False @@ -384,26 +301,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleet -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/update-azfleet](https://learn.microsoft.com/powershell/module/az.fleet/update-azfleet) - diff --git a/src/Fleet/Fleet/help/Update-AzFleetMember.md b/src/Fleet/Fleet/help/Update-AzFleetMember.md index c9bc254b75d7..bbc7248b262b 100644 --- a/src/Fleet/Fleet/help/Update-AzFleetMember.md +++ b/src/Fleet/Fleet/help/Update-AzFleetMember.md @@ -15,41 +15,36 @@ Update a FleetMember ### UpdateExpanded (Default) ``` Update-AzFleetMember -FleetName -Name -ResourceGroupName [-SubscriptionId ] - [-IfMatch ] [-Group ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-IfMatch ] [-Group ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaJsonString ``` Update-AzFleetMember -FleetName -Name -ResourceGroupName [-SubscriptionId ] - [-IfMatch ] -JsonString [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-IfMatch ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaJsonFilePath ``` Update-AzFleetMember -FleetName -Name -ResourceGroupName [-SubscriptionId ] - [-IfMatch ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-IfMatch ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityFleetExpanded ``` Update-AzFleetMember -Name -FleetInputObject [-IfMatch ] [-Group ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzFleetMember -InputObject [-IfMatch ] [-Group ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -57,17 +52,56 @@ Update a FleetMember ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update fleet member with specified member name and fleet name +```powershell Update-AzFleetMember -FleetName testfleet01 -ResourceGroupName K8sFleet-Test -Name testmember -Group 'group-a' ``` -### EXAMPLE 2 +```output +ClusterResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/TestCluster01 +ETag : "ca06635b-0000-0100-0000-655c797d0000" +Group : group-a +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/members/testmember +Name : testmember +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +SystemDataCreatedAt : 11/21/2023 9:33:48 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/21/2023 9:33:48 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Type : Microsoft.ContainerService/fleets/members ``` + +This command updates fleet member with specified member name and fleet name. + +### Example 2: Update fleet member with specified fleet object and member name +```powershell $member = Get-AzFleetMember -FleetName testfleet01 -ResourceGroupName K8sFleet-Test -Name testmember Update-AzFleetMember -InputObject $member -Group 'group-a' ``` +```output +ClusterResourceId : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/TestCluster01 +ETag : "ca06266c-0000-0100-0000-655c79fa0000" +Group : group-a +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/members/testmember +Name : testmember +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +SystemDataCreatedAt : 11/21/2023 9:35:54 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/21/2023 9:35:54 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Type : Microsoft.ContainerService/fleets/members +``` + +The first command get a fleet. +The second command updates fleet member with specified fleet object and member name. + ## PARAMETERS ### -AsJob @@ -80,22 +114,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -118,7 +137,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -162,36 +180,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IfMatch The request should only proceed if an entity matches this string. @@ -209,7 +197,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -276,21 +263,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -298,13 +270,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -313,21 +285,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -354,7 +311,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -396,36 +353,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetMember -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/update-azfleetmember](https://learn.microsoft.com/powershell/module/az.fleet/update-azfleetmember) - diff --git a/src/Fleet/Fleet/help/Update-AzFleetUpdateRun.md b/src/Fleet/Fleet/help/Update-AzFleetUpdateRun.md index c7a115469ec0..c7630ad433ad 100644 --- a/src/Fleet/Fleet/help/Update-AzFleetUpdateRun.md +++ b/src/Fleet/Fleet/help/Update-AzFleetUpdateRun.md @@ -15,30 +15,22 @@ Create a UpdateRun ### UpdateExpanded (Default) ``` Update-AzFleetUpdateRun -FleetName -Name -ResourceGroupName - [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] [-NodeImageSelectionType ] - [-StrategyStage ] [-UpdateStrategyId ] [-UpgradeKubernetesVersion ] - [-UpgradeType ] [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityFleetExpanded ``` Update-AzFleetUpdateRun -Name -FleetInputObject [-IfMatch ] - [-IfNoneMatch ] [-NodeImageSelectionType ] [-StrategyStage ] - [-UpdateStrategyId ] [-UpgradeKubernetesVersion ] [-UpgradeType ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-IfNoneMatch ] [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzFleetUpdateRun -InputObject [-IfMatch ] [-IfNoneMatch ] - [-NodeImageSelectionType ] [-StrategyStage ] [-UpdateStrategyId ] - [-UpgradeKubernetesVersion ] [-UpgradeType ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -46,11 +38,74 @@ Create a UpdateRun ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update a fleet update run +```powershell Update-AzFleetUpdateRun -FleetName testfleet01 -Name run1 -ResourceGroupName K8sFleet-Test -UpgradeKubernetesVersion "1.28.3" ``` +```output +AdditionalInfo : +Code : +Detail : +ETag : "cb067c64-0000-0100-0000-655c808d0000" +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/updateRuns/run1 +Message : +Name : run1 +NodeImageSelectionSelectedNodeImageVersion : +NodeImageSelectionType : Latest +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +StatusCompletedTime : +StatusStage : {{ + "status": { + "state": "NotStarted" + }, + "name": "default", + "groups": [ + { + "status": { + "state": "NotStarted" + }, + "name": "default", + "members": [ + { + "status": { + "state": "NotStarted" + }, + "name": "testmember", + "clusterResourceId": + "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/TestCluster01" + }, + { + "status": { + "state": "NotStarted" + }, + "name": "testmember2", + "clusterResourceId": + "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/microsoft.containerservice/managedClusters/testCluster02" + } + ] + } + ] + }} +StatusStartTime : +StatusState : NotStarted +StrategyStage : +SystemDataCreatedAt : 11/21/2023 10:03:56 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/21/2023 10:03:56 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Target : +Type : Microsoft.ContainerService/fleets/updateRuns +UpdateStrategyId : +UpgradeKubernetesVersion : 1.28.3 +UpgradeType : Full +``` + +This command updates specified fleet update run. + ## PARAMETERS ### -AsJob @@ -63,22 +118,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -101,7 +141,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -130,36 +169,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IfMatch The request should only proceed if an entity matches this string. @@ -192,7 +201,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -221,21 +229,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NodeImageSelectionType -The node image upgrade type. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -NoWait Run the command asynchronously @@ -244,21 +237,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -266,13 +244,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -281,21 +259,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -312,23 +275,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StrategyStage -The list of stages that compose this update run. -Min size: 1. -To construct, see NOTES section for STRATEGYSTAGE properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IUpdateStage[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -SubscriptionId The ID of the target subscription. @@ -339,59 +285,7 @@ Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateStrategyId -The resource id of the FleetUpdateStrategy resource to reference.When creating a new run, there are three ways to define a strategy for the run:1. -Define a new strategy in place: Set the "strategy" field.2. -Use an existing strategy: Set the "updateStrategyId" field. -(since 2023-08-15-preview)3. -Use the default strategy to update all the members one by one: Leave both "updateStrategyId" and "strategy" unset. -(since 2023-08-15-preview)Setting both "updateStrategyId" and "strategy" is invalid.UpdateRuns created by "updateStrategyId" snapshot the referenced UpdateStrategy at the time of creation and store it in the "strategy" field. -Subsequent changes to the referenced FleetUpdateStrategy resource do not propagate. -UpdateRunStrategy changes can be made directly on the "strategy" field before launching the UpdateRun. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpgradeKubernetesVersion -The Kubernetes version to upgrade the member clusters to. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpgradeType -The upgrade type.Full requires the KubernetesVersion property to be set.NodeImageOnly requires the KubernetesVersion property not to be set. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -433,48 +327,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IUpdateRun -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -STRATEGYSTAGE \: The list of stages that compose this update run. -Min size: 1. - Name \: The name of the stage. -Must be unique within the UpdateRun. - \[AfterStageWaitInSecond \\]: The time in seconds to wait at the end of this stage before starting the next one. -Defaults to 0 seconds if unspecified. - \[Group \\>\]: Defines the groups to be executed in parallel in this stage. -Duplicate groups are not allowed. -Min size: 1. - Name \: Name of the group. -It must match a group name of an existing fleet member. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/update-azfleetupdaterun](https://learn.microsoft.com/powershell/module/az.fleet/update-azfleetupdaterun) - diff --git a/src/Fleet/Fleet/help/Update-AzFleetUpdateStrategy.md b/src/Fleet/Fleet/help/Update-AzFleetUpdateStrategy.md index 668827756eff..10d4476c8a85 100644 --- a/src/Fleet/Fleet/help/Update-AzFleetUpdateStrategy.md +++ b/src/Fleet/Fleet/help/Update-AzFleetUpdateStrategy.md @@ -15,26 +15,22 @@ Create a FleetUpdateStrategy ### UpdateExpanded (Default) ``` Update-AzFleetUpdateStrategy -FleetName -Name -ResourceGroupName - [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] [-StrategyStage ] - [-DefaultProfile ] [-AsJob] [-Break] [-HttpPipelineAppend ] - [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-SubscriptionId ] [-IfMatch ] [-IfNoneMatch ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityFleetExpanded ``` Update-AzFleetUpdateStrategy -Name -FleetInputObject [-IfMatch ] - [-IfNoneMatch ] [-StrategyStage ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-IfNoneMatch ] [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzFleetUpdateStrategy -InputObject [-IfMatch ] [-IfNoneMatch ] - [-StrategyStage ] [-DefaultProfile ] [-AsJob] [-Break] - [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-NoWait] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -42,19 +38,73 @@ Create a FleetUpdateStrategy ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update a fleet update strategy with a fleet object +```powershell $f = Get-AzFleet -Name testfleet01 -ResourceGroupName K8sFleet-Test $stage = New-AzFleetUpdateStageObject -Name stag1 -Group @{name='group-a'} -AfterStageWaitInSecond 3600 Update-AzFleetUpdateStrategy -FleetInputObject $f -Name strategy3 -StrategyStage $stage ``` -### EXAMPLE 2 +```output +ETag : "8906612a-0000-0100-0000-655b2c330000" +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/updateStrategies/strategy3 +Name : strategy3 +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +StrategyStage : {{ + "name": "stag1", + "groups": [ + { + "name": "group-a" + } + ], + "afterStageWaitInSeconds": 3600 + }} +SystemDataCreatedAt : 11/20/2023 9:51:46 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/20/2023 9:51:46 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Type : Microsoft.ContainerService/fleets/updateStrategies ``` + +The first command get a fleet. +The second command creates a new fleet update stage object. +The third command updates stage for specified fleet update strategy with a fleet object. + +### Example 2: Update a fleet update strategy +```powershell $stage = New-AzFleetUpdateStageObject -Name stag1 -Group @{name='group-a'} -AfterStageWaitInSecond 360 Update-AzFleetUpdateStrategy -FleetName testfleet01 -ResourceGroupName K8sFleet-Test -Name strategy1 -StrategyStage $stage ``` +```output +ETag : "c9064db3-0000-0100-0000-655c75350000" +Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/K8sFleet-Test/providers/Microsoft.ContainerService/fleets/testfleet01/updateStrategies/strategy1 +Name : strategy1 +ProvisioningState : Succeeded +ResourceGroupName : K8sFleet-Test +StrategyStage : {{ + "name": "stag1", + "groups": [ + { + "name": "group-a" + } + ], + "afterStageWaitInSeconds": 360 + }} +SystemDataCreatedAt : 11/21/2023 9:15:33 AM +SystemDataCreatedBy : user1@example.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 11/21/2023 9:15:33 AM +SystemDataLastModifiedBy : user1@example.com +SystemDataLastModifiedByType : User +Type : Microsoft.ContainerService/fleets/updateStrategies +``` + +This command updates stage for specified fleet update strategy. + ## PARAMETERS ### -AsJob @@ -67,22 +117,7 @@ Aliases: Required: False Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Break -Wait for .NET debugger to attach - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -105,7 +140,6 @@ Accept wildcard characters: False ### -FleetInputObject Identity Parameter -To construct, see NOTES section for FLEETINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -134,36 +168,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HttpPipelineAppend -SendAsync Pipeline Steps to be appended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPipelinePrepend -SendAsync Pipeline Steps to be prepended to the front of the pipeline - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Runtime.SendAsyncStep[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -IfMatch The request should only proceed if an entity matches this string. @@ -196,7 +200,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity @@ -233,21 +236,6 @@ Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -The URI for the proxy server to use - -```yaml -Type: System.Uri -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None @@ -255,13 +243,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyCredential -Credentials for a proxy server to use for the remote call +### -ProgressAction +{{ Fill ProgressAction Description }} ```yaml -Type: System.Management.Automation.PSCredential +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) -Aliases: +Aliases: proga Required: False Position: Named @@ -270,21 +258,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyUseDefaultCredentials -Use the default credentials for the proxy - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -301,23 +274,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StrategyStage -The list of stages that compose this update run. -Min size: 1. -To construct, see NOTES section for STRATEGYSTAGE properties and create a hash table. - -```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IUpdateStage[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -SubscriptionId The ID of the target subscription. @@ -328,7 +284,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -370,48 +326,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.Fleet.Models.IFleetUpdateStrategy -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -FLEETINPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -INPUTOBJECT \: Identity Parameter - \[FleetMemberName \\]: The name of the Fleet member resource. - \[FleetName \\]: The name of the Fleet resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SubscriptionId \\]: The ID of the target subscription. - \[UpdateRunName \\]: The name of the UpdateRun resource. - \[UpdateStrategyName \\]: The name of the UpdateStrategy resource. - -STRATEGYSTAGE \: The list of stages that compose this update run. -Min size: 1. - Name \: The name of the stage. -Must be unique within the UpdateRun. - \[AfterStageWaitInSecond \\]: The time in seconds to wait at the end of this stage before starting the next one. -Defaults to 0 seconds if unspecified. - \[Group \\>\]: Defines the groups to be executed in parallel in this stage. -Duplicate groups are not allowed. -Min size: 1. - Name \: Name of the group. -It must match a group name of an existing fleet member. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.fleet/update-azfleetupdatestrategy](https://learn.microsoft.com/powershell/module/az.fleet/update-azfleetupdatestrategy) - diff --git a/src/Monitor/Monitor/help/Get-AzMetricsBatch.md b/src/Monitor/Monitor/help/Get-AzMetricsBatch.md index 785667a095b7..1d48e5392fd5 100644 --- a/src/Monitor/Monitor/help/Get-AzMetricsBatch.md +++ b/src/Monitor/Monitor/help/Get-AzMetricsBatch.md @@ -35,14 +35,543 @@ Lists the metric values for multiple resources. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Get ingress and egress from storage account +```powershell $endpoint = 'https://eastus.metrics.monitor.azure.com' $start = "2023-12-06T07:00:00.000Z" $end = "2023-12-06T08:00:00.000Z" Get-AzMetricsBatch -Endpoint $endpoint -Name 'ingress','egress' -Namespace "Microsoft.Storage/storageAccounts" -EndTime $end -StartTime $start -ResourceId /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/joyer-monitor/providers/Microsoft.Storage/storageAccounts/psmetric01 ``` +```output +Endtime : 2023-12-06T08:00:00Z +Interval : 00:01:00a +Namespace : Microsoft.Storage/storageAccounts +Resourceid : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/joyer-monitor/providers/Microsoft.Storage/storageAccounts/psmetric01 +Resourceregion : eastus +Starttime : 2023-12-06T07:00:00Z +Value : {{ + "name": { + "value": "Ingress", + "localizedValue": "Ingress" + }, + "id": "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/joyer-monitor/providers/Microsoft.Storage/storageAccounts/psmetric01/providers/Microsoft.Insigh + ts/metrics/Ingress", + "type": "Microsoft.Insights/metrics", + "displayDescription": "The amount of ingress data, in bytes. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.", + "errorCode": "Success", + "unit": "Bytes", + "timeseries": [ + { + "metadatavalues": [ ], + "data": [ + { + "timeStamp": "2023-12-06T07:00:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:01:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:02:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:03:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:04:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:05:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:06:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:07:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:08:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:09:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:10:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:11:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:12:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:13:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:14:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:15:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:16:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:17:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:18:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:19:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:20:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:21:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:22:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:23:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:24:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:25:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:26:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:27:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:28:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:29:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:30:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:31:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:32:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:33:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:34:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:35:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:36:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:37:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:38:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:39:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:40:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:41:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:42:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:43:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:44:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:45:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:46:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:47:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:48:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:49:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:50:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:51:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:52:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:53:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:54:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:55:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:56:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:57:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:58:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:59:00.0000000Z", + "total": 0 + } + ] + } + ] + }, { + "name": { + "value": "Egress", + "localizedValue": "Egress" + }, + "id": "/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourcegroups/joyer-monitor/providers/Microsoft.Storage/storageAccounts/psmetric01/providers/Microsoft.Insigh + ts/metrics/Egress", + "type": "Microsoft.Insights/metrics", + "displayDescription": "The amount of egress data. This number includes egress to external client from Azure Storage as well as egress within Azure. As a result, this + number does not reflect billable egress.", + "errorCode": "Success", + "unit": "Bytes", + "timeseries": [ + { + "metadatavalues": [ ], + "data": [ + { + "timeStamp": "2023-12-06T07:00:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:01:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:02:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:03:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:04:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:05:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:06:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:07:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:08:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:09:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:10:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:11:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:12:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:13:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:14:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:15:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:16:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:17:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:18:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:19:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:20:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:21:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:22:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:23:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:24:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:25:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:26:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:27:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:28:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:29:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:30:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:31:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:32:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:33:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:34:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:35:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:36:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:37:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:38:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:39:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:40:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:41:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:42:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:43:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:44:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:45:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:46:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:47:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:48:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:49:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:50:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:51:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:52:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:53:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:54:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:55:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:56:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:57:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:58:00.0000000Z", + "total": 0 + }, + { + "timeStamp": "2023-12-06T07:59:00.0000000Z", + "total": 0 + } + ] + } + ] + }} +``` + +This command lists the metric values for specified resources. + ## PARAMETERS ### -Aggregation diff --git a/src/VMware/VMware/help/Az.VMware.md b/src/VMware/VMware/help/Az.VMware.md index 3749ab677398..8f5657052793 100644 --- a/src/VMware/VMware/help/Az.VMware.md +++ b/src/VMware/VMware/help/Az.VMware.md @@ -23,6 +23,9 @@ Get an cloud link by name in a private cloud ### [Get-AzVMwareCluster](Get-AzVMwareCluster.md) Get a cluster by name in a private cloud +### [Get-AzVMwareClusterZone](Get-AzVMwareClusterZone.md) +List hosts by zone in a cluster + ### [Get-AzVMwareDatastore](Get-AzVMwareDatastore.md) Get a datastore in a private cloud cluster @@ -51,25 +54,28 @@ Create a in-memory object for AddonSrmProperties Create a in-memory object for AddonVrProperties ### [New-AzVMwareAuthorization](New-AzVMwareAuthorization.md) -Create or update an ExpressRoute Circuit Authorization in a private cloud +Create an ExpressRoute Circuit Authorization in a private cloud ### [New-AzVMwareCloudLink](New-AzVMwareCloudLink.md) -Create or update a cloud link in a private cloud +Create a cloud link in a private cloud ### [New-AzVMwareCluster](New-AzVMwareCluster.md) -Create or update a cluster in a private cloud +Create a cluster in a private cloud ### [New-AzVMwareDatastore](New-AzVMwareDatastore.md) -Create or update a datastore in a private cloud cluster +Create a datastore in a private cloud cluster ### [New-AzVMwareGlobalReachConnection](New-AzVMwareGlobalReachConnection.md) -Create or update a global reach connection in a private cloud +Create a global reach connection in a private cloud + +### [New-AzVMwareIdentitySourceObject](New-AzVMwareIdentitySourceObject.md) +Create an in-memory object for IdentitySource. ### [New-AzVMwarePlacementPolicy](New-AzVMwarePlacementPolicy.md) -Create or update a placement policy in a private cloud cluster +Create a placement policy in a private cloud cluster ### [New-AzVMwarePrivateCloud](New-AzVMwarePrivateCloud.md) -Create or update a private cloud +Create a private cloud ### [New-AzVMwarePrivateCloudNsxtPassword](New-AzVMwarePrivateCloudNsxtPassword.md) Rotate the NSX-T Manager password @@ -122,12 +128,24 @@ Return quota for subscription by region ### [Test-AzVMwareLocationTrialAvailability](Test-AzVMwareLocationTrialAvailability.md) Return trial status for subscription by region +### [Update-AzVMwareAuthorization](Update-AzVMwareAuthorization.md) +Create an ExpressRoute Circuit Authorization in a private cloud + +### [Update-AzVMwareCloudLink](Update-AzVMwareCloudLink.md) +Create a cloud link in a private cloud + ### [Update-AzVMwareCluster](Update-AzVMwareCluster.md) Update a cluster in a private cloud +### [Update-AzVMwareDatastore](Update-AzVMwareDatastore.md) +Create a datastore in a private cloud cluster + +### [Update-AzVMwareGlobalReachConnection](Update-AzVMwareGlobalReachConnection.md) +Create a global reach connection in a private cloud + ### [Update-AzVMwarePlacementPolicy](Update-AzVMwarePlacementPolicy.md) Update a placement policy in a private cloud cluster ### [Update-AzVMwarePrivateCloud](Update-AzVMwarePrivateCloud.md) -Update a private cloud +Create a private cloud diff --git a/src/VMware/VMware/help/Get-AzVMwareAddon.md b/src/VMware/VMware/help/Get-AzVMwareAddon.md index 67c8c926c1b2..dd7d30c5ad7d 100644 --- a/src/VMware/VMware/help/Get-AzVMwareAddon.md +++ b/src/VMware/VMware/help/Get-AzVMwareAddon.md @@ -15,18 +15,19 @@ Get an addon by name in a private cloud ### List (Default) ``` Get-AzVMwareAddon -PrivateCloudName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzVMwareAddon -PrivateCloudName -ResourceGroupName [-SubscriptionId ] - -AddonType [-DefaultProfile ] [] + -AddonType [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzVMwareAddon -InputObject [-DefaultProfile ] [] +Get-AzVMwareAddon -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -124,6 +125,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -164,42 +180,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IAddon +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IAddon ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Get-AzVMwareAuthorization.md b/src/VMware/VMware/help/Get-AzVMwareAuthorization.md index 2bcc0b6e1c05..edca9b5bbca9 100644 --- a/src/VMware/VMware/help/Get-AzVMwareAuthorization.md +++ b/src/VMware/VMware/help/Get-AzVMwareAuthorization.md @@ -15,24 +15,26 @@ Get an ExpressRoute Circuit Authorization by name in a private cloud ### List (Default) ``` Get-AzVMwareAuthorization -PrivateCloudName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentityPrivateCloud ``` Get-AzVMwareAuthorization -Name -PrivateCloudInputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzVMwareAuthorization -Name -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentity ``` -Get-AzVMwareAuthorization -InputObject [-DefaultProfile ] [] +Get-AzVMwareAuthorization -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -69,7 +71,8 @@ Get authorization by name in a private cloud ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -85,7 +88,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -116,7 +118,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -145,6 +146,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -185,42 +201,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IExpressRouteAuthorization +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IExpressRouteAuthorization ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Get-AzVMwareCloudLink.md b/src/VMware/VMware/help/Get-AzVMwareCloudLink.md index 8b9c5ea24322..b5ffe1ebb2c6 100644 --- a/src/VMware/VMware/help/Get-AzVMwareCloudLink.md +++ b/src/VMware/VMware/help/Get-AzVMwareCloudLink.md @@ -15,24 +15,26 @@ Get an cloud link by name in a private cloud ### List (Default) ``` Get-AzVMwareCloudLink -PrivateCloudName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentityPrivateCloud ``` Get-AzVMwareCloudLink -Name -PrivateCloudInputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ### Get ``` Get-AzVMwareCloudLink -Name -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentity ``` -Get-AzVMwareCloudLink -InputObject [-DefaultProfile ] [] +Get-AzVMwareCloudLink -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -69,7 +71,8 @@ Get cloud link by name in a private cloud ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -85,7 +88,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -116,7 +118,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -145,6 +146,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -185,42 +201,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ICloudLink +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.ICloudLink ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Get-AzVMwareCluster.md b/src/VMware/VMware/help/Get-AzVMwareCluster.md index e5681b64abec..bd59d7aaf50d 100644 --- a/src/VMware/VMware/help/Get-AzVMwareCluster.md +++ b/src/VMware/VMware/help/Get-AzVMwareCluster.md @@ -15,24 +15,26 @@ Get a cluster by name in a private cloud ### List (Default) ``` Get-AzVMwareCluster -PrivateCloudName -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentityPrivateCloud ``` Get-AzVMwareCluster -Name -PrivateCloudInputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ### Get ``` Get-AzVMwareCluster -Name -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentity ``` -Get-AzVMwareCluster -InputObject [-DefaultProfile ] [] +Get-AzVMwareCluster -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -69,7 +71,8 @@ Get cluster by name in a private cloud ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -85,7 +88,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -116,7 +118,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -145,6 +146,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -185,42 +201,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ICluster +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.ICluster ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Get-AzVMwareClusterZone.md b/src/VMware/VMware/help/Get-AzVMwareClusterZone.md index c2e7a13065f2..a474861f3ce5 100644 --- a/src/VMware/VMware/help/Get-AzVMwareClusterZone.md +++ b/src/VMware/VMware/help/Get-AzVMwareClusterZone.md @@ -14,7 +14,8 @@ List hosts by zone in a cluster ``` Get-AzVMwareClusterZone -ClusterName -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -22,18 +23,26 @@ List hosts by zone in a cluster ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List hosts by zone in a cluster +```powershell Get-AzVMwareClusterZone -PrivateCloudName SDDC2 -ResourceGroupName TestSddc-rg -ClusterName Cluster-1 ``` +```output +Host Zone +---- ---- +{esx09-r09.p01.canadacentral.avs.azure.com, esx02-r06.p01.canadacentral.avs.azure.com, esx20-r08.p01.canadacentral.avs.azure.com} 3 +``` + +List hosts by zone in a cluster + ## PARAMETERS ### -ClusterName Name of the cluster in the private cloud ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -49,7 +58,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -64,7 +73,7 @@ Accept wildcard characters: False Name of the private cloud ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -75,12 +84,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -95,13 +119,13 @@ Accept wildcard characters: False The ID of the target subscription. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -110,7 +134,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -126,7 +150,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -145,9 +169,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IClusterZoneList + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.vmware/get-azvmwareclusterzone](https://learn.microsoft.com/powershell/module/az.vmware/get-azvmwareclusterzone) - diff --git a/src/VMware/VMware/help/Get-AzVMwareDatastore.md b/src/VMware/VMware/help/Get-AzVMwareDatastore.md index 3353754b95b9..ff620769c9e1 100644 --- a/src/VMware/VMware/help/Get-AzVMwareDatastore.md +++ b/src/VMware/VMware/help/Get-AzVMwareDatastore.md @@ -15,30 +15,33 @@ Get a datastore in a private cloud cluster ### List (Default) ``` Get-AzVMwareDatastore -ClusterName -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentityPrivateCloud ``` Get-AzVMwareDatastore -ClusterName -Name -PrivateCloudInputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzVMwareDatastore -ClusterName -Name -PrivateCloudName - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetViaIdentityCluster ``` Get-AzVMwareDatastore -Name -ClusterInputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzVMwareDatastore -InputObject [-DefaultProfile ] [] +Get-AzVMwareDatastore -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -77,7 +80,6 @@ Get a datastore in a data store name. ### -ClusterInputObject Identity Parameter -To construct, see NOTES section for CLUSTERINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -107,7 +109,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -123,7 +126,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -154,7 +156,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -183,6 +184,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -223,42 +239,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IDatastore +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IDatastore ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Get-AzVMwareGlobalReachConnection.md b/src/VMware/VMware/help/Get-AzVMwareGlobalReachConnection.md index 37327c5c4998..421ce6060193 100644 --- a/src/VMware/VMware/help/Get-AzVMwareGlobalReachConnection.md +++ b/src/VMware/VMware/help/Get-AzVMwareGlobalReachConnection.md @@ -15,25 +15,27 @@ Get a global reach connection by name in a private cloud ### List (Default) ``` Get-AzVMwareGlobalReachConnection -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentityPrivateCloud ``` Get-AzVMwareGlobalReachConnection -Name -PrivateCloudInputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzVMwareGlobalReachConnection -Name -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentity ``` Get-AzVMwareGlobalReachConnection -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -70,7 +72,8 @@ Get a global reach connection by name in a private cloud ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -86,7 +89,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -117,7 +119,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -146,6 +147,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -186,42 +202,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IGlobalReachConnection +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IGlobalReachConnection ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Get-AzVMwarePlacementPolicy.md b/src/VMware/VMware/help/Get-AzVMwarePlacementPolicy.md index fdf0bc8d7dec..210a7294221b 100644 --- a/src/VMware/VMware/help/Get-AzVMwarePlacementPolicy.md +++ b/src/VMware/VMware/help/Get-AzVMwarePlacementPolicy.md @@ -15,30 +15,33 @@ Get a placement policy by name in a private cloud cluster ### List (Default) ``` Get-AzVMwarePlacementPolicy -ClusterName -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentityPrivateCloud ``` Get-AzVMwarePlacementPolicy -ClusterName -Name -PrivateCloudInputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzVMwarePlacementPolicy -ClusterName -Name -PrivateCloudName - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetViaIdentityCluster ``` Get-AzVMwarePlacementPolicy -Name -ClusterInputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzVMwarePlacementPolicy -InputObject [-DefaultProfile ] [] +Get-AzVMwarePlacementPolicy -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -77,7 +80,6 @@ Get a placement policy by name in a private cloud cluster ### -ClusterInputObject Identity Parameter -To construct, see NOTES section for CLUSTERINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -107,7 +109,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -123,7 +126,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -154,7 +156,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -183,6 +184,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -223,42 +239,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IPlacementPolicy +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IPlacementPolicy ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Get-AzVMwarePrivateCloud.md b/src/VMware/VMware/help/Get-AzVMwarePrivateCloud.md index fa97346a58f0..e2dee200a7d8 100644 --- a/src/VMware/VMware/help/Get-AzVMwarePrivateCloud.md +++ b/src/VMware/VMware/help/Get-AzVMwarePrivateCloud.md @@ -14,24 +14,26 @@ Get a private cloud ### List1 (Default) ``` -Get-AzVMwarePrivateCloud [-SubscriptionId ] [-DefaultProfile ] [] +Get-AzVMwarePrivateCloud [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzVMwarePrivateCloud -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List ``` Get-AzVMwarePrivateCloud -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzVMwarePrivateCloud -InputObject [-DefaultProfile ] [] +Get-AzVMwarePrivateCloud -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -81,7 +83,8 @@ Get a private cloud by name ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -97,7 +100,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -126,6 +128,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -166,42 +183,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IPrivateCloud +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IPrivateCloud ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Get-AzVMwarePrivateCloudAdminCredential.md b/src/VMware/VMware/help/Get-AzVMwarePrivateCloudAdminCredential.md index 1fe8650b4801..81ff72a4cd97 100644 --- a/src/VMware/VMware/help/Get-AzVMwarePrivateCloudAdminCredential.md +++ b/src/VMware/VMware/help/Get-AzVMwarePrivateCloudAdminCredential.md @@ -14,7 +14,8 @@ List the admin credentials for the private cloud ``` Get-AzVMwarePrivateCloudAdminCredential -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -38,7 +39,8 @@ Get the admin credentials for the private cloud ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -67,6 +69,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -136,10 +153,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IAdminCredentials +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IAdminCredentials ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Get-AzVMwareVirtualMachine.md b/src/VMware/VMware/help/Get-AzVMwareVirtualMachine.md index a0c5c9ac7dcc..cd75f4f80c97 100644 --- a/src/VMware/VMware/help/Get-AzVMwareVirtualMachine.md +++ b/src/VMware/VMware/help/Get-AzVMwareVirtualMachine.md @@ -15,30 +15,33 @@ Get a virtual machine by id in a private cloud cluster ### List (Default) ``` Get-AzVMwareVirtualMachine -ClusterName -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentityPrivateCloud ``` Get-AzVMwareVirtualMachine -ClusterName -Id -PrivateCloudInputObject - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzVMwareVirtualMachine -ClusterName -Id -PrivateCloudName - -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] + -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetViaIdentityCluster ``` Get-AzVMwareVirtualMachine -Id -ClusterInputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzVMwareVirtualMachine -InputObject [-DefaultProfile ] [] +Get-AzVMwareVirtualMachine -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -77,7 +80,6 @@ Get a virtual machine by id in a private cloud cluster ### -ClusterInputObject Identity Parameter -To construct, see NOTES section for CLUSTERINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -107,7 +109,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -138,7 +141,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -154,7 +156,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -183,6 +184,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -223,42 +239,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IVirtualMachine +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVirtualMachine ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareAddon.md b/src/VMware/VMware/help/New-AzVMwareAddon.md index 7a07e9fe5fda..01e39cab3a85 100644 --- a/src/VMware/VMware/help/New-AzVMwareAddon.md +++ b/src/VMware/VMware/help/New-AzVMwareAddon.md @@ -14,8 +14,8 @@ Create or update a addon in a private cloud ``` New-AzVMwareAddon -PrivateCloudName -ResourceGroupName [-SubscriptionId ] - [-Property ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-Property ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -99,6 +99,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Property The properties of an addon resource To construct, see NOTES section for PROPERTY properties and create a hash table. @@ -184,18 +199,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IAddon +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IAddon ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`PROPERTY `: The properties of an addon resource - - `AddonType `: The type of private cloud addon - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareAddonSrmPropertiesObject.md b/src/VMware/VMware/help/New-AzVMwareAddonSrmPropertiesObject.md index e2caed546386..c3eb7e865583 100644 --- a/src/VMware/VMware/help/New-AzVMwareAddonSrmPropertiesObject.md +++ b/src/VMware/VMware/help/New-AzVMwareAddonSrmPropertiesObject.md @@ -13,7 +13,8 @@ Create a in-memory object for AddonSrmProperties ## SYNTAX ``` -New-AzVMwareAddonSrmPropertiesObject -LicenseKey [] +New-AzVMwareAddonSrmPropertiesObject -LicenseKey [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -27,9 +28,9 @@ New-AzVMwareAddonSrmPropertiesObject -LicenseKey "YourLicenseKeyValue" ``` ```output -AddonType ProvisioningState LicenseKey ---------- ----------------- ---------- -SRM YourLicenseKeyValue +AddonType LicenseKey ProvisioningState +--------- ---------- ----------------- +SRM YourLicenseKeyValue ``` Create a local SRM object for the Addon Property parameter @@ -51,6 +52,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +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). @@ -58,10 +74,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.AddonSrmProperties +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.AddonSrmProperties ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareAddonVrPropertiesObject.md b/src/VMware/VMware/help/New-AzVMwareAddonVrPropertiesObject.md index 1232d6c1efc9..d94621c71b12 100644 --- a/src/VMware/VMware/help/New-AzVMwareAddonVrPropertiesObject.md +++ b/src/VMware/VMware/help/New-AzVMwareAddonVrPropertiesObject.md @@ -13,7 +13,7 @@ Create a in-memory object for AddonVrProperties ## SYNTAX ``` -New-AzVMwareAddonVrPropertiesObject -VrsCount [] +New-AzVMwareAddonVrPropertiesObject -VrsCount [-ProgressAction ] [] ``` ## DESCRIPTION @@ -29,13 +29,28 @@ New-AzVMwareAddonVrPropertiesObject -VrsCount 2 ```output AddonType ProvisioningState VrsCount --------- ----------------- -------- -VR 2 +VR 2 ``` Create a local VR object for the Addon Property parameter ## PARAMETERS +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -VrsCount The vSphere Replication Server (VRS) count. @@ -58,10 +73,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.AddonVrProperties +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.AddonVrProperties ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareAuthorization.md b/src/VMware/VMware/help/New-AzVMwareAuthorization.md index 3bfd1e39bbad..c51a84737050 100644 --- a/src/VMware/VMware/help/New-AzVMwareAuthorization.md +++ b/src/VMware/VMware/help/New-AzVMwareAuthorization.md @@ -8,31 +8,32 @@ schema: 2.0.0 # New-AzVMwareAuthorization ## SYNOPSIS -Create or update an ExpressRoute Circuit Authorization in a private cloud +Create an ExpressRoute Circuit Authorization in a private cloud ## SYNTAX ### CreateExpanded (Default) ``` New-AzVMwareAuthorization -Name -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityPrivateCloudExpanded ``` New-AzVMwareAuthorization -Name -PrivateCloudInputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaIdentityExpanded ``` New-AzVMwareAuthorization -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Create or update an ExpressRoute Circuit Authorization in a private cloud +Create an ExpressRoute Circuit Authorization in a private cloud ## EXAMPLES @@ -67,7 +68,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -83,7 +85,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -129,7 +130,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -158,6 +158,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -225,12 +240,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IExpressRouteAuthorization +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IExpressRouteAuthorization ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareCloudLink.md b/src/VMware/VMware/help/New-AzVMwareCloudLink.md index 6e6fd5723909..54041b5e668c 100644 --- a/src/VMware/VMware/help/New-AzVMwareCloudLink.md +++ b/src/VMware/VMware/help/New-AzVMwareCloudLink.md @@ -8,31 +8,32 @@ schema: 2.0.0 # New-AzVMwareCloudLink ## SYNOPSIS -Create or update a cloud link in a private cloud +Create a cloud link in a private cloud ## SYNTAX ### CreateExpanded (Default) ``` New-AzVMwareCloudLink -Name -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-LinkedCloud ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] - [-Confirm] [] + [-SubscriptionId ] [-LinkedCloud ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityPrivateCloudExpanded ``` New-AzVMwareCloudLink -Name -PrivateCloudInputObject [-LinkedCloud ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaIdentityExpanded ``` New-AzVMwareCloudLink -InputObject [-LinkedCloud ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Create or update a cloud link in a private cloud +Create a cloud link in a private cloud ## EXAMPLES @@ -67,7 +68,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -83,7 +85,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -144,7 +145,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -173,6 +173,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -240,12 +255,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ICloudLink +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.ICloudLink ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareCluster.md b/src/VMware/VMware/help/New-AzVMwareCluster.md index e5709ea134b9..a95aa17f33ed 100644 --- a/src/VMware/VMware/help/New-AzVMwareCluster.md +++ b/src/VMware/VMware/help/New-AzVMwareCluster.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzVMwareCluster ## SYNOPSIS -Create or update a cluster in a private cloud +Create a cluster in a private cloud ## SYNTAX @@ -16,25 +16,26 @@ Create or update a cluster in a private cloud ``` New-AzVMwareCluster -Name -PrivateCloudName -ResourceGroupName [-SubscriptionId ] -SkuName [-ClusterSize ] [-PropertiesHost ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaIdentityPrivateCloudExpanded ``` New-AzVMwareCluster -Name -PrivateCloudInputObject -SkuName - [-ClusterSize ] [-PropertiesHost ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] - [-Confirm] [] + [-ClusterSize ] [-PropertiesHost ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityExpanded ``` New-AzVMwareCluster -InputObject -SkuName [-ClusterSize ] - [-PropertiesHost ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-PropertiesHost ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Create or update a cluster in a private cloud +Create a cluster in a private cloud ## EXAMPLES @@ -84,7 +85,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -100,7 +102,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -146,7 +147,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -175,6 +175,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PropertiesHost The hosts @@ -272,12 +287,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ICluster +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.ICluster ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareDatastore.md b/src/VMware/VMware/help/New-AzVMwareDatastore.md index 222553bce20c..a226c199445a 100644 --- a/src/VMware/VMware/help/New-AzVMwareDatastore.md +++ b/src/VMware/VMware/help/New-AzVMwareDatastore.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzVMwareDatastore ## SYNOPSIS -Create or update a datastore in a private cloud cluster +Create a datastore in a private cloud cluster ## SYNTAX @@ -17,33 +17,36 @@ Create or update a datastore in a private cloud cluster New-AzVMwareDatastore -ClusterName -Name -PrivateCloudName -ResourceGroupName [-SubscriptionId ] [-DiskPoolVolumeLunName ] [-DiskPoolVolumeMountOption ] [-DiskPoolVolumeTargetId ] [-NetAppVolumeId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaIdentityPrivateCloudExpanded ``` New-AzVMwareDatastore -ClusterName -Name -PrivateCloudInputObject [-DiskPoolVolumeLunName ] [-DiskPoolVolumeMountOption ] [-DiskPoolVolumeTargetId ] - [-NetAppVolumeId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-NetAppVolumeId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityClusterExpanded ``` New-AzVMwareDatastore -Name -ClusterInputObject [-DiskPoolVolumeLunName ] [-DiskPoolVolumeMountOption ] [-DiskPoolVolumeTargetId ] [-NetAppVolumeId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaIdentityExpanded ``` New-AzVMwareDatastore -InputObject [-DiskPoolVolumeLunName ] [-DiskPoolVolumeMountOption ] [-DiskPoolVolumeTargetId ] [-NetAppVolumeId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -Create or update a datastore in a private cloud cluster +Create a datastore in a private cloud cluster ## EXAMPLES @@ -79,7 +82,6 @@ Accept wildcard characters: False ### -ClusterInputObject Identity Parameter -To construct, see NOTES section for CLUSTERINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -109,7 +111,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -170,7 +173,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -231,7 +233,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -260,6 +261,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -327,12 +343,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IDatastore +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IDatastore ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareGlobalReachConnection.md b/src/VMware/VMware/help/New-AzVMwareGlobalReachConnection.md index 45ee4acf9025..a2d6eb9e0cc9 100644 --- a/src/VMware/VMware/help/New-AzVMwareGlobalReachConnection.md +++ b/src/VMware/VMware/help/New-AzVMwareGlobalReachConnection.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzVMwareGlobalReachConnection ## SYNOPSIS -Create or update a global reach connection in a private cloud +Create a global reach connection in a private cloud ## SYNTAX @@ -16,26 +16,27 @@ Create or update a global reach connection in a private cloud ``` New-AzVMwareGlobalReachConnection -Name -PrivateCloudName -ResourceGroupName [-SubscriptionId ] [-AuthorizationKey ] [-ExpressRouteId ] - [-PeerExpressRouteResourceId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-PeerExpressRouteResourceId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityPrivateCloudExpanded ``` New-AzVMwareGlobalReachConnection -Name -PrivateCloudInputObject [-AuthorizationKey ] [-ExpressRouteId ] [-PeerExpressRouteResourceId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaIdentityExpanded ``` New-AzVMwareGlobalReachConnection -InputObject [-AuthorizationKey ] [-ExpressRouteId ] [-PeerExpressRouteResourceId ] [-DefaultProfile ] [-AsJob] - [-NoWait] [-WhatIf] [-Confirm] [] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Create or update a global reach connection in a private cloud +Create a global reach connection in a private cloud ## EXAMPLES @@ -85,7 +86,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -116,7 +118,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -177,7 +178,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -206,6 +206,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -273,12 +288,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IGlobalReachConnection +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IGlobalReachConnection ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareIdentitySourceObject.md b/src/VMware/VMware/help/New-AzVMwareIdentitySourceObject.md index d1832d3640c2..4d7dc22ef347 100644 --- a/src/VMware/VMware/help/New-AzVMwareIdentitySourceObject.md +++ b/src/VMware/VMware/help/New-AzVMwareIdentitySourceObject.md @@ -15,7 +15,7 @@ Create an in-memory object for IdentitySource. ``` New-AzVMwareIdentitySourceObject [-Alias ] [-BaseGroupDn ] [-BaseUserDn ] [-Domain ] [-Name ] [-Password ] [-PrimaryServer ] [-SecondaryServer ] - [-Ssl ] [-Username ] [] + [-Ssl ] [-Username ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -23,18 +23,33 @@ Create an in-memory object for IdentitySource. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create an in-memory object for IdentitySource +```powershell New-AzVMwareIdentitySourceObject -Alias test ``` +```output +Alias : test +BaseGroupDn : +BaseUserDn : +Domain : +Name : +Password : +PrimaryServer : +SecondaryServer : +Ssl : +Username : +``` + +Create an in-memory object for IdentitySource + ## PARAMETERS ### -Alias The domain's NetBIOS name. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -49,7 +64,7 @@ Accept wildcard characters: False The base distinguished name for groups. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -64,7 +79,7 @@ Accept wildcard characters: False The base distinguished name for users. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -79,7 +94,7 @@ Accept wildcard characters: False The domain's dns name. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -94,7 +109,7 @@ Accept wildcard characters: False The name of the identity source. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -109,7 +124,7 @@ Accept wildcard characters: False The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -124,7 +139,7 @@ Accept wildcard characters: False Primary server URL. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -135,11 +150,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SecondaryServer Secondary server URL. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -154,7 +184,7 @@ Accept wildcard characters: False Protect LDAP communication using SSL certificate (LDAPS). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -169,7 +199,7 @@ Accept wildcard characters: False The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -188,9 +218,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IdentitySource + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/Az.VMware/new-azvmwareidentitysourceobject](https://learn.microsoft.com/powershell/module/Az.VMware/new-azvmwareidentitysourceobject) - diff --git a/src/VMware/VMware/help/New-AzVMwarePSCredentialExecutionParameterObject.md b/src/VMware/VMware/help/New-AzVMwarePSCredentialExecutionParameterObject.md index 4311668c0ef2..37ae171be055 100644 --- a/src/VMware/VMware/help/New-AzVMwarePSCredentialExecutionParameterObject.md +++ b/src/VMware/VMware/help/New-AzVMwarePSCredentialExecutionParameterObject.md @@ -14,7 +14,7 @@ Create a in-memory object for PSCredentialExecutionParameter ``` New-AzVMwarePSCredentialExecutionParameterObject -Name [-Password ] [-Username ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -28,9 +28,9 @@ New-AzVMwarePSCredentialExecutionParameterObject -Name azps_test_credentialvalue ``` ```output -Name Type Password Username ----- ---- -------- -------- -azps_test_credentialvalue Credential passwordValue usernameValue +Name Password Type Username +---- -------- ---- -------- +azps_test_credentialvalue passwordValue Credential usernameValue ``` Create a local PS Credential Execution object @@ -67,6 +67,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Username username for login. @@ -89,10 +104,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.PsCredentialExecutionParameter +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.PsCredentialExecutionParameter ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwarePlacementPolicy.md b/src/VMware/VMware/help/New-AzVMwarePlacementPolicy.md index 9680aa437d16..1efaac267eee 100644 --- a/src/VMware/VMware/help/New-AzVMwarePlacementPolicy.md +++ b/src/VMware/VMware/help/New-AzVMwarePlacementPolicy.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzVMwarePlacementPolicy ## SYNOPSIS -Create or update a placement policy in a private cloud cluster +Create a placement policy in a private cloud cluster ## SYNTAX @@ -16,31 +16,33 @@ Create or update a placement policy in a private cloud cluster ``` New-AzVMwarePlacementPolicy -ClusterName -Name -PrivateCloudName -ResourceGroupName [-SubscriptionId ] [-Property ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### CreateViaIdentityPrivateCloudExpanded ``` New-AzVMwarePlacementPolicy -ClusterName -Name -PrivateCloudInputObject - [-Property ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-Property ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityClusterExpanded ``` New-AzVMwarePlacementPolicy -Name -ClusterInputObject - [-Property ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-Property ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityExpanded ``` New-AzVMwarePlacementPolicy -InputObject [-Property ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -Create or update a placement policy in a private cloud cluster +Create a placement policy in a private cloud cluster ## EXAMPLES @@ -91,7 +93,6 @@ Accept wildcard characters: False ### -ClusterInputObject Identity Parameter -To construct, see NOTES section for CLUSTERINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -121,7 +122,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -137,7 +139,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -183,7 +184,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -212,9 +212,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Property placement policy properties -To construct, see NOTES section for PROPERTY properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IPlacementPolicyProperties @@ -295,22 +309,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IPlacementPolicy +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IPlacementPolicy ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`PROPERTY `: placement policy properties - - `Type `: placement policy type - - `[DisplayName ]`: Display name of the placement policy - - `[State ]`: Whether the placement policy is enabled or disabled - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwarePrivateCloud.md b/src/VMware/VMware/help/New-AzVMwarePrivateCloud.md index d949a6ab2f57..df94152fcc6c 100644 --- a/src/VMware/VMware/help/New-AzVMwarePrivateCloud.md +++ b/src/VMware/VMware/help/New-AzVMwarePrivateCloud.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzVMwarePrivateCloud ## SYNOPSIS -Create or update a private cloud +Create a private cloud ## SYNTAX @@ -20,11 +20,12 @@ New-AzVMwarePrivateCloud -Name -ResourceGroupName [-Subscripti [-IdentityType ] [-Internet ] [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUrl ] [-KeyVaultPropertyKeyVersion ] [-ManagementClusterHost ] [-NsxtPassword ] [-Tag ] [-VcenterPassword ] - [-AcceptEULA] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-AcceptEULA] [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -Create or update a private cloud +Create a private cloud ## EXAMPLES @@ -83,7 +84,7 @@ Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -113,13 +114,14 @@ Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -364,6 +366,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -476,12 +493,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IPrivateCloud +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IPrivateCloud ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwarePrivateCloudNsxtPassword.md b/src/VMware/VMware/help/New-AzVMwarePrivateCloudNsxtPassword.md index 5f07306e5c61..c4f5a2aceab7 100644 --- a/src/VMware/VMware/help/New-AzVMwarePrivateCloudNsxtPassword.md +++ b/src/VMware/VMware/help/New-AzVMwarePrivateCloudNsxtPassword.md @@ -15,14 +15,14 @@ Rotate the NSX-T Manager password ### Rotate (Default) ``` New-AzVMwarePrivateCloudNsxtPassword -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### RotateViaIdentity ``` New-AzVMwarePrivateCloudNsxtPassword -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -59,7 +59,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -75,7 +76,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -134,6 +134,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -209,38 +224,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwarePrivateCloudVcenterPassword.md b/src/VMware/VMware/help/New-AzVMwarePrivateCloudVcenterPassword.md index fcb5f166e69f..7b94f5eb1e54 100644 --- a/src/VMware/VMware/help/New-AzVMwarePrivateCloudVcenterPassword.md +++ b/src/VMware/VMware/help/New-AzVMwarePrivateCloudVcenterPassword.md @@ -15,14 +15,14 @@ Rotate the vCenter password ### Rotate (Default) ``` New-AzVMwarePrivateCloudVcenterPassword -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### RotateViaIdentity ``` New-AzVMwarePrivateCloudVcenterPassword -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -59,7 +59,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -75,7 +76,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -134,6 +134,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -209,38 +224,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareScriptSecureStringExecutionParameterObject.md b/src/VMware/VMware/help/New-AzVMwareScriptSecureStringExecutionParameterObject.md index b4344ec226ae..38ed6ad3a859 100644 --- a/src/VMware/VMware/help/New-AzVMwareScriptSecureStringExecutionParameterObject.md +++ b/src/VMware/VMware/help/New-AzVMwareScriptSecureStringExecutionParameterObject.md @@ -14,7 +14,7 @@ Create a in-memory object for ScriptSecureStringExecutionParameter ``` New-AzVMwareScriptSecureStringExecutionParameterObject -Name [-SecureValue ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -28,9 +28,9 @@ New-AzVMwareScriptSecureStringExecutionParameterObject -Name azps_test_secureval ``` ```output -Name Type SecureValue ----- ---- ----------- -azps_test_securevalue SecureValue passwordValue +Name SecureValue Type +---- ----------- ---- +azps_test_securevalue passwordValue SecureValue ``` Create a local Script Secure String Execution object @@ -52,6 +52,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SecureValue A secure value for the passed parameter, not to be stored in logs. @@ -74,10 +89,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ScriptSecureStringExecutionParameter +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.ScriptSecureStringExecutionParameter ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareScriptStringExecutionParameterObject.md b/src/VMware/VMware/help/New-AzVMwareScriptStringExecutionParameterObject.md index 0da7647fa56d..f5ab8058ea38 100644 --- a/src/VMware/VMware/help/New-AzVMwareScriptStringExecutionParameterObject.md +++ b/src/VMware/VMware/help/New-AzVMwareScriptStringExecutionParameterObject.md @@ -13,7 +13,8 @@ Create a in-memory object for ScriptStringExecutionParameter ## SYNTAX ``` -New-AzVMwareScriptStringExecutionParameterObject -Name [-Value ] [] +New-AzVMwareScriptStringExecutionParameterObject -Name [-Value ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -23,13 +24,13 @@ Create a in-memory object for ScriptStringExecutionParameter ### Example 1: Create a local Script String Execution object ```powershell -New-AzVMwareScriptStringExecutionParameterObject -Name azps_test_stringvalue -Value "stringValue" +New-AzVMwareScriptStringExecutionParameterObject -Name azps_test_value -Value "passwordValue" ``` ```output -Name Type Value ----- ---- ----- -azps_test_stringvalue Value stringValue +Name Value +---- ----------- +azps_test_value passwordValue ``` Create a local Script String Execution object @@ -51,6 +52,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Value The value for the passed parameter. @@ -73,10 +89,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ScriptStringExecutionParameter +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.ScriptStringExecutionParameter ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareVMPlacementPolicyPropertiesObject.md b/src/VMware/VMware/help/New-AzVMwareVMPlacementPolicyPropertiesObject.md index 18c361bd2a33..23900915d143 100644 --- a/src/VMware/VMware/help/New-AzVMwareVMPlacementPolicyPropertiesObject.md +++ b/src/VMware/VMware/help/New-AzVMwareVMPlacementPolicyPropertiesObject.md @@ -14,7 +14,7 @@ Create an in-memory object for VMPlacementPolicyProperties. ``` New-AzVMwareVMPlacementPolicyPropertiesObject -AffinityType -VMMember -Type - [-DisplayName ] [-State ] [] + [-DisplayName ] [-State ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -24,13 +24,16 @@ Create an in-memory object for VMPlacementPolicyProperties. ### Example 1: Create an in-memory object for VMPlacementPolicyProperties. ```powershell -New-AzVMwareVMPlacementPolicyPropertiesObject -AffinityType 'Affinity' -Type 'VmVm' -VMMember @{"abc"="123"} +New-AzVMwareVMPlacementPolicyPropertiesObject -AffinityType 'Affinity' -Type 'VmVm' -VMMember @{"test"="test"} ``` ```output -DisplayName ProvisioningState State AffinityType VMMember ------------ ----------------- ----- ------------ -------- - Affinity {System.Collections.Hashtable} +AffinityType : Affinity +DisplayName : +ProvisioningState : +State : +Type : VmVm +VMMember : {System.Collections.Hashtable} ``` Create an in-memory object for VMPlacementPolicyProperties. @@ -67,6 +70,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -State Whether the placement policy is enabled or disabled. @@ -119,10 +137,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.VMPlacementPolicyProperties +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.VMPlacementPolicyProperties ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/New-AzVMwareVmHostPlacementPolicyPropertiesObject.md b/src/VMware/VMware/help/New-AzVMwareVmHostPlacementPolicyPropertiesObject.md index 56df4aed9604..6263303fd680 100644 --- a/src/VMware/VMware/help/New-AzVMwareVmHostPlacementPolicyPropertiesObject.md +++ b/src/VMware/VMware/help/New-AzVMwareVmHostPlacementPolicyPropertiesObject.md @@ -14,7 +14,8 @@ Create an in-memory object for VmHostPlacementPolicyProperties. ``` New-AzVMwareVmHostPlacementPolicyPropertiesObject -AffinityType -HostMember - -VMMember -Type [-DisplayName ] [-State ] [] + -VMMember -Type [-DisplayName ] [-State ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -24,13 +25,19 @@ Create an in-memory object for VmHostPlacementPolicyProperties. ### Example 1: Create an in-memory object for VmHostPlacementPolicyProperties. ```powershell -New-AzVMwareVmHostPlacementPolicyPropertiesObject -AffinityType 'AntiAffinity' -HostMember @{"abc"="123"} -Type 'VmHost' -VMMember @{"abc"="123"} +New-AzVMwareVmHostPlacementPolicyPropertiesObject -AffinityType 'AntiAffinity' -HostMember @{"test"="test"} -Type 'VmHost' -VMMember @{"test"="test"} ``` ```output -DisplayName ProvisioningState State AffinityType HostMember VMMember ------------ ----------------- ----- ------------ ---------- -------- - AntiAffinity {System.Collections.Hashtable} {System.Collections.Hashtable} +AffinityStrength : +AffinityType : AntiAffinity +AzureHybridBenefitType : +DisplayName : +HostMember : {System.Collections.Hashtable} +ProvisioningState : +State : +Type : VmHost +VMMember : {System.Collections.Hashtable} ``` Create an in-memory object for VmHostPlacementPolicyProperties. @@ -82,6 +89,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -State Whether the placement policy is enabled or disabled. @@ -134,10 +156,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.VMHostPlacementPolicyProperties +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.VMHostPlacementPolicyProperties ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Remove-AzVMwareAddon.md b/src/VMware/VMware/help/Remove-AzVMwareAddon.md index fc472f9a25c3..deed95a8b7b4 100644 --- a/src/VMware/VMware/help/Remove-AzVMwareAddon.md +++ b/src/VMware/VMware/help/Remove-AzVMwareAddon.md @@ -15,14 +15,14 @@ Delete a addon in a private cloud ### Delete (Default) ``` Remove-AzVMwareAddon -AddonType -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzVMwareAddon -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -152,6 +152,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -227,38 +242,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Remove-AzVMwareAuthorization.md b/src/VMware/VMware/help/Remove-AzVMwareAuthorization.md index 5506c5770622..32bb6f92bec5 100644 --- a/src/VMware/VMware/help/Remove-AzVMwareAuthorization.md +++ b/src/VMware/VMware/help/Remove-AzVMwareAuthorization.md @@ -15,20 +15,21 @@ Delete an ExpressRoute Circuit Authorization in a private cloud ### Delete (Default) ``` Remove-AzVMwareAuthorization -Name -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentityPrivateCloud ``` Remove-AzVMwareAuthorization -Name -PrivateCloudInputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzVMwareAuthorization -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -68,7 +69,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -84,7 +86,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -145,7 +146,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -174,6 +174,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -249,38 +264,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Remove-AzVMwareCloudLink.md b/src/VMware/VMware/help/Remove-AzVMwareCloudLink.md index 8dc473478057..0feedf34c633 100644 --- a/src/VMware/VMware/help/Remove-AzVMwareCloudLink.md +++ b/src/VMware/VMware/help/Remove-AzVMwareCloudLink.md @@ -15,20 +15,20 @@ Delete a cloud link in a private cloud ### Delete (Default) ``` Remove-AzVMwareCloudLink -Name -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentityPrivateCloud ``` Remove-AzVMwareCloudLink -Name -PrivateCloudInputObject [-DefaultProfile ] - [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzVMwareCloudLink -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -68,7 +68,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -84,7 +85,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -145,7 +145,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -174,6 +173,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -249,38 +263,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Remove-AzVMwareCluster.md b/src/VMware/VMware/help/Remove-AzVMwareCluster.md index e88594c2a6e5..839da50eb116 100644 --- a/src/VMware/VMware/help/Remove-AzVMwareCluster.md +++ b/src/VMware/VMware/help/Remove-AzVMwareCluster.md @@ -15,20 +15,20 @@ Delete a cluster in a private cloud ### Delete (Default) ``` Remove-AzVMwareCluster -Name -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentityPrivateCloud ``` Remove-AzVMwareCluster -Name -PrivateCloudInputObject [-DefaultProfile ] - [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzVMwareCluster -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -68,7 +68,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -84,7 +85,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -145,7 +145,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -174,6 +173,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -249,38 +263,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Remove-AzVMwareDatastore.md b/src/VMware/VMware/help/Remove-AzVMwareDatastore.md index e80ad4c670ad..47fd39ec58c8 100644 --- a/src/VMware/VMware/help/Remove-AzVMwareDatastore.md +++ b/src/VMware/VMware/help/Remove-AzVMwareDatastore.md @@ -16,25 +16,26 @@ Delete a datastore in a private cloud cluster ``` Remove-AzVMwareDatastore -ClusterName -Name -PrivateCloudName -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentityPrivateCloud ``` Remove-AzVMwareDatastore -ClusterName -Name -PrivateCloudInputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentityCluster ``` Remove-AzVMwareDatastore -Name -ClusterInputObject [-DefaultProfile ] - [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzVMwareDatastore -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -75,7 +76,6 @@ Accept wildcard characters: False ### -ClusterInputObject Identity Parameter -To construct, see NOTES section for CLUSTERINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -105,7 +105,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -121,7 +122,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -182,7 +182,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -211,6 +210,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -286,38 +300,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Remove-AzVMwareGlobalReachConnection.md b/src/VMware/VMware/help/Remove-AzVMwareGlobalReachConnection.md index b5180c9f2ed0..74bc17e32ad4 100644 --- a/src/VMware/VMware/help/Remove-AzVMwareGlobalReachConnection.md +++ b/src/VMware/VMware/help/Remove-AzVMwareGlobalReachConnection.md @@ -15,20 +15,21 @@ Delete a global reach connection in a private cloud ### Delete (Default) ``` Remove-AzVMwareGlobalReachConnection -Name -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentityPrivateCloud ``` Remove-AzVMwareGlobalReachConnection -Name -PrivateCloudInputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzVMwareGlobalReachConnection -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -68,7 +69,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -84,7 +86,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -145,7 +146,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -174,6 +174,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -249,38 +264,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Remove-AzVMwarePlacementPolicy.md b/src/VMware/VMware/help/Remove-AzVMwarePlacementPolicy.md index e919450f33e9..91b4e7b85f33 100644 --- a/src/VMware/VMware/help/Remove-AzVMwarePlacementPolicy.md +++ b/src/VMware/VMware/help/Remove-AzVMwarePlacementPolicy.md @@ -16,25 +16,27 @@ Delete a placement policy in a private cloud cluster ``` Remove-AzVMwarePlacementPolicy -ClusterName -Name -PrivateCloudName -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentityPrivateCloud ``` Remove-AzVMwarePlacementPolicy -ClusterName -Name -PrivateCloudInputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentityCluster ``` Remove-AzVMwarePlacementPolicy -Name -ClusterInputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzVMwarePlacementPolicy -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -75,7 +77,6 @@ Accept wildcard characters: False ### -ClusterInputObject Identity Parameter -To construct, see NOTES section for CLUSTERINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -105,7 +106,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -121,7 +123,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -182,7 +183,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -211,6 +211,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -286,38 +301,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Remove-AzVMwarePrivateCloud.md b/src/VMware/VMware/help/Remove-AzVMwarePrivateCloud.md index 01341b81d5ed..3d011401915a 100644 --- a/src/VMware/VMware/help/Remove-AzVMwarePrivateCloud.md +++ b/src/VMware/VMware/help/Remove-AzVMwarePrivateCloud.md @@ -15,13 +15,14 @@ Delete a private cloud ### Delete (Default) ``` Remove-AzVMwarePrivateCloud -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzVMwarePrivateCloud -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -136,6 +137,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -211,38 +227,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Test-AzVMwareLocationQuotaAvailability.md b/src/VMware/VMware/help/Test-AzVMwareLocationQuotaAvailability.md index 749cc75e3466..2d272703cdd4 100644 --- a/src/VMware/VMware/help/Test-AzVMwareLocationQuotaAvailability.md +++ b/src/VMware/VMware/help/Test-AzVMwareLocationQuotaAvailability.md @@ -14,7 +14,7 @@ Return quota for subscription by region ``` Test-AzVMwareLocationQuotaAvailability -Location [-SubscriptionId ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -38,7 +38,8 @@ Check quota availability ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -67,6 +68,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId The ID of the target subscription. @@ -120,10 +136,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IQuota +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IQuota ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Test-AzVMwareLocationTrialAvailability.md b/src/VMware/VMware/help/Test-AzVMwareLocationTrialAvailability.md index f0ab9407a21f..5e9b795fee15 100644 --- a/src/VMware/VMware/help/Test-AzVMwareLocationTrialAvailability.md +++ b/src/VMware/VMware/help/Test-AzVMwareLocationTrialAvailability.md @@ -14,7 +14,7 @@ Return trial status for subscription by region ``` Test-AzVMwareLocationTrialAvailability -Location [-SubscriptionId ] [-Name ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -24,7 +24,7 @@ Return trial status for subscription by region ### Example 1: Check trial availability ```powershell -Test-AzVMwareLocationTrialAvailability -Location westcentralus +Test-AzVMwareLocationTrialAvailability -Location westcentralus -Name av36 ``` ```output @@ -38,7 +38,8 @@ Check trial availability ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -82,6 +83,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId The ID of the target subscription. @@ -135,10 +151,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ITrial +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.ITrial ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Update-AzVMwareAuthorization.md b/src/VMware/VMware/help/Update-AzVMwareAuthorization.md index 1f210ffe2796..b248e3055a7b 100644 --- a/src/VMware/VMware/help/Update-AzVMwareAuthorization.md +++ b/src/VMware/VMware/help/Update-AzVMwareAuthorization.md @@ -15,20 +15,21 @@ Create an ExpressRoute Circuit Authorization in a private cloud ### UpdateExpanded (Default) ``` Update-AzVMwareAuthorization -Name -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityPrivateCloudExpanded ``` Update-AzVMwareAuthorization -Name -PrivateCloudInputObject - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzVMwareAuthorization -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,24 +37,37 @@ Create an ExpressRoute Circuit Authorization in a private cloud ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update an ExpressRoute Circuit Authorization in a private cloud +```powershell Update-AzVMwareAuthorization -Name azps_test_authorization -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group ``` +```output +ExpressRouteAuthorizationId : ExpressRouteURI +ExpressRouteId : ExpressRouteId +Id : Id +Key : GUID +Name : azps_test_authorization +ProvisioningState : Succeeded +ResourceGroupName : azps_test_group +Type : Microsoft.AVS/privateClouds/authorizations +``` + +Update an ExpressRoute Circuit Authorization in a private cloud + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -63,7 +77,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -76,10 +90,9 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: IVMwareIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity Parameter Sets: UpdateViaIdentityExpanded Aliases: @@ -94,7 +107,7 @@ Accept wildcard characters: False Name of the ExpressRoute Circuit Authorization in the private cloud ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaIdentityPrivateCloudExpanded Aliases: AuthorizationName @@ -109,23 +122,22 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml -Type: IVMwareIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity Parameter Sets: UpdateViaIdentityPrivateCloudExpanded Aliases: @@ -140,7 +152,7 @@ Accept wildcard characters: False The name of the private cloud. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: @@ -151,12 +163,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: @@ -171,13 +198,13 @@ Accept wildcard characters: False The ID of the target subscription. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -186,7 +213,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -202,7 +229,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -219,90 +246,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IExpressRouteAuthorization + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[AddonName \\]: Name of the addon for the private cloud - \[AuthorizationName \\]: Name of the ExpressRoute Circuit Authorization in the private cloud - \[CloudLinkName \\]: Name of the cloud link resource - \[ClusterName \\]: Name of the cluster in the private cloud - \[DatastoreName \\]: Name of the datastore in the private cloud cluster - \[DhcpId \\]: NSX DHCP identifier. -Generally the same as the DHCP display name - \[DnsServiceId \\]: NSX DNS Service identifier. -Generally the same as the DNS Service's display name - \[DnsZoneId \\]: NSX DNS Zone identifier. -Generally the same as the DNS Zone's display name - \[GatewayId \\]: NSX Gateway identifier. -Generally the same as the Gateway's display name - \[GlobalReachConnectionName \\]: Name of the global reach connection in the private cloud - \[HcxEnterpriseSiteName \\]: Name of the HCX Enterprise Site in the private cloud - \[Id \\]: Resource identity path - \[Location \\]: Azure region - \[PlacementPolicyName \\]: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - \[PortMirroringId \\]: NSX Port Mirroring identifier. -Generally the same as the Port Mirroring display name - \[PrivateCloudName \\]: Name of the private cloud - \[PublicIPId \\]: NSX Public IP Block identifier. -Generally the same as the Public IP Block's display name - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ScriptCmdletName \\]: Name of the script cmdlet resource in the script package in the private cloud - \[ScriptExecutionName \\]: Name of the user-invoked script execution resource - \[ScriptPackageName \\]: Name of the script package in the private cloud - \[SegmentId \\]: NSX Segment identifier. -Generally the same as the Segment's display name - \[SubscriptionId \\]: The ID of the target subscription. - \[VMGroupId \\]: NSX VM Group identifier. -Generally the same as the VM Group's display name - \[VirtualMachineId \\]: Virtual Machine identifier - \[WorkloadNetworkName \\]: Name for the workload network in the private cloud - -PRIVATECLOUDINPUTOBJECT \: Identity Parameter - \[AddonName \\]: Name of the addon for the private cloud - \[AuthorizationName \\]: Name of the ExpressRoute Circuit Authorization in the private cloud - \[CloudLinkName \\]: Name of the cloud link resource - \[ClusterName \\]: Name of the cluster in the private cloud - \[DatastoreName \\]: Name of the datastore in the private cloud cluster - \[DhcpId \\]: NSX DHCP identifier. -Generally the same as the DHCP display name - \[DnsServiceId \\]: NSX DNS Service identifier. -Generally the same as the DNS Service's display name - \[DnsZoneId \\]: NSX DNS Zone identifier. -Generally the same as the DNS Zone's display name - \[GatewayId \\]: NSX Gateway identifier. -Generally the same as the Gateway's display name - \[GlobalReachConnectionName \\]: Name of the global reach connection in the private cloud - \[HcxEnterpriseSiteName \\]: Name of the HCX Enterprise Site in the private cloud - \[Id \\]: Resource identity path - \[Location \\]: Azure region - \[PlacementPolicyName \\]: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - \[PortMirroringId \\]: NSX Port Mirroring identifier. -Generally the same as the Port Mirroring display name - \[PrivateCloudName \\]: Name of the private cloud - \[PublicIPId \\]: NSX Public IP Block identifier. -Generally the same as the Public IP Block's display name - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ScriptCmdletName \\]: Name of the script cmdlet resource in the script package in the private cloud - \[ScriptExecutionName \\]: Name of the user-invoked script execution resource - \[ScriptPackageName \\]: Name of the script package in the private cloud - \[SegmentId \\]: NSX Segment identifier. -Generally the same as the Segment's display name - \[SubscriptionId \\]: The ID of the target subscription. - \[VMGroupId \\]: NSX VM Group identifier. -Generally the same as the VM Group's display name - \[VirtualMachineId \\]: Virtual Machine identifier - \[WorkloadNetworkName \\]: Name for the workload network in the private cloud ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.vmware/update-azvmwareauthorization](https://learn.microsoft.com/powershell/module/az.vmware/update-azvmwareauthorization) - diff --git a/src/VMware/VMware/help/Update-AzVMwareCloudLink.md b/src/VMware/VMware/help/Update-AzVMwareCloudLink.md index a9dd6bee4d7e..91bf1070ca29 100644 --- a/src/VMware/VMware/help/Update-AzVMwareCloudLink.md +++ b/src/VMware/VMware/help/Update-AzVMwareCloudLink.md @@ -15,20 +15,21 @@ Create a cloud link in a private cloud ### UpdateExpanded (Default) ``` Update-AzVMwareCloudLink -Name -PrivateCloudName -ResourceGroupName - [-SubscriptionId ] [-LinkedCloud ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] - [-Confirm] [] + [-SubscriptionId ] [-LinkedCloud ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityPrivateCloudExpanded ``` Update-AzVMwareCloudLink -Name -PrivateCloudInputObject [-LinkedCloud ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzVMwareCloudLink -InputObject [-LinkedCloud ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,24 +37,32 @@ Create a cloud link in a private cloud ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update a cloud link in a private cloud +```powershell Update-AzVMwareCloudLink -Name azps_test_cloudlink -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -LinkedCloud "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/azps_test_group2/providers/Microsoft.AVS/privateClouds/azps_test_cloud2/" ``` +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_cloudlink Microsoft.AVS/privateClouds/cloudLinks azps_test_group +``` + +Update a cloud link in a private cloud + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -63,7 +72,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -76,10 +85,9 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: IVMwareIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity Parameter Sets: UpdateViaIdentityExpanded Aliases: @@ -94,7 +102,7 @@ Accept wildcard characters: False Identifier of the other private cloud participating in the link. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -109,7 +117,7 @@ Accept wildcard characters: False Name of the cloud link resource ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaIdentityPrivateCloudExpanded Aliases: CloudLinkName @@ -124,23 +132,22 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml -Type: IVMwareIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity Parameter Sets: UpdateViaIdentityPrivateCloudExpanded Aliases: @@ -155,7 +162,7 @@ Accept wildcard characters: False The name of the private cloud. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: @@ -166,12 +173,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: @@ -186,13 +208,13 @@ Accept wildcard characters: False The ID of the target subscription. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -201,7 +223,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -217,7 +239,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -234,90 +256,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.ICloudLink + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[AddonName \\]: Name of the addon for the private cloud - \[AuthorizationName \\]: Name of the ExpressRoute Circuit Authorization in the private cloud - \[CloudLinkName \\]: Name of the cloud link resource - \[ClusterName \\]: Name of the cluster in the private cloud - \[DatastoreName \\]: Name of the datastore in the private cloud cluster - \[DhcpId \\]: NSX DHCP identifier. -Generally the same as the DHCP display name - \[DnsServiceId \\]: NSX DNS Service identifier. -Generally the same as the DNS Service's display name - \[DnsZoneId \\]: NSX DNS Zone identifier. -Generally the same as the DNS Zone's display name - \[GatewayId \\]: NSX Gateway identifier. -Generally the same as the Gateway's display name - \[GlobalReachConnectionName \\]: Name of the global reach connection in the private cloud - \[HcxEnterpriseSiteName \\]: Name of the HCX Enterprise Site in the private cloud - \[Id \\]: Resource identity path - \[Location \\]: Azure region - \[PlacementPolicyName \\]: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - \[PortMirroringId \\]: NSX Port Mirroring identifier. -Generally the same as the Port Mirroring display name - \[PrivateCloudName \\]: Name of the private cloud - \[PublicIPId \\]: NSX Public IP Block identifier. -Generally the same as the Public IP Block's display name - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ScriptCmdletName \\]: Name of the script cmdlet resource in the script package in the private cloud - \[ScriptExecutionName \\]: Name of the user-invoked script execution resource - \[ScriptPackageName \\]: Name of the script package in the private cloud - \[SegmentId \\]: NSX Segment identifier. -Generally the same as the Segment's display name - \[SubscriptionId \\]: The ID of the target subscription. - \[VMGroupId \\]: NSX VM Group identifier. -Generally the same as the VM Group's display name - \[VirtualMachineId \\]: Virtual Machine identifier - \[WorkloadNetworkName \\]: Name for the workload network in the private cloud - -PRIVATECLOUDINPUTOBJECT \: Identity Parameter - \[AddonName \\]: Name of the addon for the private cloud - \[AuthorizationName \\]: Name of the ExpressRoute Circuit Authorization in the private cloud - \[CloudLinkName \\]: Name of the cloud link resource - \[ClusterName \\]: Name of the cluster in the private cloud - \[DatastoreName \\]: Name of the datastore in the private cloud cluster - \[DhcpId \\]: NSX DHCP identifier. -Generally the same as the DHCP display name - \[DnsServiceId \\]: NSX DNS Service identifier. -Generally the same as the DNS Service's display name - \[DnsZoneId \\]: NSX DNS Zone identifier. -Generally the same as the DNS Zone's display name - \[GatewayId \\]: NSX Gateway identifier. -Generally the same as the Gateway's display name - \[GlobalReachConnectionName \\]: Name of the global reach connection in the private cloud - \[HcxEnterpriseSiteName \\]: Name of the HCX Enterprise Site in the private cloud - \[Id \\]: Resource identity path - \[Location \\]: Azure region - \[PlacementPolicyName \\]: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - \[PortMirroringId \\]: NSX Port Mirroring identifier. -Generally the same as the Port Mirroring display name - \[PrivateCloudName \\]: Name of the private cloud - \[PublicIPId \\]: NSX Public IP Block identifier. -Generally the same as the Public IP Block's display name - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ScriptCmdletName \\]: Name of the script cmdlet resource in the script package in the private cloud - \[ScriptExecutionName \\]: Name of the user-invoked script execution resource - \[ScriptPackageName \\]: Name of the script package in the private cloud - \[SegmentId \\]: NSX Segment identifier. -Generally the same as the Segment's display name - \[SubscriptionId \\]: The ID of the target subscription. - \[VMGroupId \\]: NSX VM Group identifier. -Generally the same as the VM Group's display name - \[VirtualMachineId \\]: Virtual Machine identifier - \[WorkloadNetworkName \\]: Name for the workload network in the private cloud ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.vmware/update-azvmwarecloudlink](https://learn.microsoft.com/powershell/module/az.vmware/update-azvmwarecloudlink) - diff --git a/src/VMware/VMware/help/Update-AzVMwareCluster.md b/src/VMware/VMware/help/Update-AzVMwareCluster.md index d74ac532dd13..34eb74b04e1a 100644 --- a/src/VMware/VMware/help/Update-AzVMwareCluster.md +++ b/src/VMware/VMware/help/Update-AzVMwareCluster.md @@ -16,20 +16,21 @@ Update a cluster in a private cloud ``` Update-AzVMwareCluster -Name -PrivateCloudName -ResourceGroupName [-SubscriptionId ] [-ClusterSize ] [-PropertiesHost ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityPrivateCloudExpanded ``` Update-AzVMwareCluster -Name -PrivateCloudInputObject [-ClusterSize ] - [-PropertiesHost ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-PropertiesHost ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzVMwareCluster -InputObject [-ClusterSize ] [-PropertiesHost ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -96,7 +97,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -112,7 +114,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -158,7 +159,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -187,6 +187,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PropertiesHost The hosts @@ -273,42 +288,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.ICluster +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.ICluster ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Update-AzVMwareDatastore.md b/src/VMware/VMware/help/Update-AzVMwareDatastore.md index 6460bd872524..f13e5f380323 100644 --- a/src/VMware/VMware/help/Update-AzVMwareDatastore.md +++ b/src/VMware/VMware/help/Update-AzVMwareDatastore.md @@ -17,29 +17,32 @@ Create a datastore in a private cloud cluster Update-AzVMwareDatastore -ClusterName -Name -PrivateCloudName -ResourceGroupName [-SubscriptionId ] [-DiskPoolVolumeLunName ] [-DiskPoolVolumeMountOption ] [-DiskPoolVolumeTargetId ] [-NetAppVolumeId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityPrivateCloudExpanded ``` Update-AzVMwareDatastore -ClusterName -Name -PrivateCloudInputObject [-DiskPoolVolumeLunName ] [-DiskPoolVolumeMountOption ] [-DiskPoolVolumeTargetId ] - [-NetAppVolumeId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-NetAppVolumeId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityClusterExpanded ``` Update-AzVMwareDatastore -Name -ClusterInputObject [-DiskPoolVolumeLunName ] [-DiskPoolVolumeMountOption ] [-DiskPoolVolumeTargetId ] [-NetAppVolumeId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzVMwareDatastore -InputObject [-DiskPoolVolumeLunName ] [-DiskPoolVolumeMountOption ] [-DiskPoolVolumeTargetId ] [-NetAppVolumeId ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -47,34 +50,41 @@ Create a datastore in a private cloud cluster ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update a datastore in a private cloud cluster. +```powershell Update-AzVMwareDatastore -ClusterName azps_test_cluster -Name azps_test_datastore -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group -NetAppVolumeId "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/azps_test_group/providers/Microsoft.NetApp/netAppAccounts/NetAppAccount1/capacityPools/CapacityPool1/volumes/NFSVol1" ``` +```output +Name Status ProvisioningState ResourceGroupName +---- ------ ----------------- ----------------- +azps_test_datastore Accessible Succeeded azps_test_group +``` + +Update a datastore in a private cloud cluster. + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ClusterInputObject Identity Parameter -To construct, see NOTES section for CLUSTERINPUTOBJECT properties and create a hash table. ```yaml -Type: IVMwareIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity Parameter Sets: UpdateViaIdentityClusterExpanded Aliases: @@ -89,7 +99,7 @@ Accept wildcard characters: False Name of the cluster in the private cloud ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaIdentityPrivateCloudExpanded Aliases: @@ -105,7 +115,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -120,7 +130,7 @@ Accept wildcard characters: False Name of the LUN to be used for datastore ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -135,7 +145,7 @@ Accept wildcard characters: False Mode that describes whether the LUN has to be mounted as a datastore or attached as a LUN ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -150,7 +160,7 @@ Accept wildcard characters: False Azure resource ID of the iSCSI target ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -163,10 +173,9 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: IVMwareIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity Parameter Sets: UpdateViaIdentityExpanded Aliases: @@ -181,7 +190,7 @@ Accept wildcard characters: False Name of the datastore in the private cloud cluster ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaIdentityPrivateCloudExpanded, UpdateViaIdentityClusterExpanded Aliases: DatastoreName @@ -196,7 +205,7 @@ Accept wildcard characters: False Azure resource ID of the NetApp volume ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -211,23 +220,22 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml -Type: IVMwareIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity Parameter Sets: UpdateViaIdentityPrivateCloudExpanded Aliases: @@ -242,7 +250,7 @@ Accept wildcard characters: False Name of the private cloud ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: @@ -253,12 +261,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: @@ -273,13 +296,13 @@ Accept wildcard characters: False The ID of the target subscription. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -288,7 +311,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -304,7 +327,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -321,127 +344,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IDatastore + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -CLUSTERINPUTOBJECT \: Identity Parameter - \[AddonName \\]: Name of the addon for the private cloud - \[AuthorizationName \\]: Name of the ExpressRoute Circuit Authorization in the private cloud - \[CloudLinkName \\]: Name of the cloud link resource - \[ClusterName \\]: Name of the cluster in the private cloud - \[DatastoreName \\]: Name of the datastore in the private cloud cluster - \[DhcpId \\]: NSX DHCP identifier. -Generally the same as the DHCP display name - \[DnsServiceId \\]: NSX DNS Service identifier. -Generally the same as the DNS Service's display name - \[DnsZoneId \\]: NSX DNS Zone identifier. -Generally the same as the DNS Zone's display name - \[GatewayId \\]: NSX Gateway identifier. -Generally the same as the Gateway's display name - \[GlobalReachConnectionName \\]: Name of the global reach connection in the private cloud - \[HcxEnterpriseSiteName \\]: Name of the HCX Enterprise Site in the private cloud - \[Id \\]: Resource identity path - \[Location \\]: Azure region - \[PlacementPolicyName \\]: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - \[PortMirroringId \\]: NSX Port Mirroring identifier. -Generally the same as the Port Mirroring display name - \[PrivateCloudName \\]: Name of the private cloud - \[PublicIPId \\]: NSX Public IP Block identifier. -Generally the same as the Public IP Block's display name - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ScriptCmdletName \\]: Name of the script cmdlet resource in the script package in the private cloud - \[ScriptExecutionName \\]: Name of the user-invoked script execution resource - \[ScriptPackageName \\]: Name of the script package in the private cloud - \[SegmentId \\]: NSX Segment identifier. -Generally the same as the Segment's display name - \[SubscriptionId \\]: The ID of the target subscription. - \[VMGroupId \\]: NSX VM Group identifier. -Generally the same as the VM Group's display name - \[VirtualMachineId \\]: Virtual Machine identifier - \[WorkloadNetworkName \\]: Name for the workload network in the private cloud - -INPUTOBJECT \: Identity Parameter - \[AddonName \\]: Name of the addon for the private cloud - \[AuthorizationName \\]: Name of the ExpressRoute Circuit Authorization in the private cloud - \[CloudLinkName \\]: Name of the cloud link resource - \[ClusterName \\]: Name of the cluster in the private cloud - \[DatastoreName \\]: Name of the datastore in the private cloud cluster - \[DhcpId \\]: NSX DHCP identifier. -Generally the same as the DHCP display name - \[DnsServiceId \\]: NSX DNS Service identifier. -Generally the same as the DNS Service's display name - \[DnsZoneId \\]: NSX DNS Zone identifier. -Generally the same as the DNS Zone's display name - \[GatewayId \\]: NSX Gateway identifier. -Generally the same as the Gateway's display name - \[GlobalReachConnectionName \\]: Name of the global reach connection in the private cloud - \[HcxEnterpriseSiteName \\]: Name of the HCX Enterprise Site in the private cloud - \[Id \\]: Resource identity path - \[Location \\]: Azure region - \[PlacementPolicyName \\]: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - \[PortMirroringId \\]: NSX Port Mirroring identifier. -Generally the same as the Port Mirroring display name - \[PrivateCloudName \\]: Name of the private cloud - \[PublicIPId \\]: NSX Public IP Block identifier. -Generally the same as the Public IP Block's display name - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ScriptCmdletName \\]: Name of the script cmdlet resource in the script package in the private cloud - \[ScriptExecutionName \\]: Name of the user-invoked script execution resource - \[ScriptPackageName \\]: Name of the script package in the private cloud - \[SegmentId \\]: NSX Segment identifier. -Generally the same as the Segment's display name - \[SubscriptionId \\]: The ID of the target subscription. - \[VMGroupId \\]: NSX VM Group identifier. -Generally the same as the VM Group's display name - \[VirtualMachineId \\]: Virtual Machine identifier - \[WorkloadNetworkName \\]: Name for the workload network in the private cloud - -PRIVATECLOUDINPUTOBJECT \: Identity Parameter - \[AddonName \\]: Name of the addon for the private cloud - \[AuthorizationName \\]: Name of the ExpressRoute Circuit Authorization in the private cloud - \[CloudLinkName \\]: Name of the cloud link resource - \[ClusterName \\]: Name of the cluster in the private cloud - \[DatastoreName \\]: Name of the datastore in the private cloud cluster - \[DhcpId \\]: NSX DHCP identifier. -Generally the same as the DHCP display name - \[DnsServiceId \\]: NSX DNS Service identifier. -Generally the same as the DNS Service's display name - \[DnsZoneId \\]: NSX DNS Zone identifier. -Generally the same as the DNS Zone's display name - \[GatewayId \\]: NSX Gateway identifier. -Generally the same as the Gateway's display name - \[GlobalReachConnectionName \\]: Name of the global reach connection in the private cloud - \[HcxEnterpriseSiteName \\]: Name of the HCX Enterprise Site in the private cloud - \[Id \\]: Resource identity path - \[Location \\]: Azure region - \[PlacementPolicyName \\]: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - \[PortMirroringId \\]: NSX Port Mirroring identifier. -Generally the same as the Port Mirroring display name - \[PrivateCloudName \\]: Name of the private cloud - \[PublicIPId \\]: NSX Public IP Block identifier. -Generally the same as the Public IP Block's display name - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ScriptCmdletName \\]: Name of the script cmdlet resource in the script package in the private cloud - \[ScriptExecutionName \\]: Name of the user-invoked script execution resource - \[ScriptPackageName \\]: Name of the script package in the private cloud - \[SegmentId \\]: NSX Segment identifier. -Generally the same as the Segment's display name - \[SubscriptionId \\]: The ID of the target subscription. - \[VMGroupId \\]: NSX VM Group identifier. -Generally the same as the VM Group's display name - \[VirtualMachineId \\]: Virtual Machine identifier - \[WorkloadNetworkName \\]: Name for the workload network in the private cloud ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.vmware/update-azvmwaredatastore](https://learn.microsoft.com/powershell/module/az.vmware/update-azvmwaredatastore) - diff --git a/src/VMware/VMware/help/Update-AzVMwareGlobalReachConnection.md b/src/VMware/VMware/help/Update-AzVMwareGlobalReachConnection.md index f80ae1e96b4d..8217a8ef23c7 100644 --- a/src/VMware/VMware/help/Update-AzVMwareGlobalReachConnection.md +++ b/src/VMware/VMware/help/Update-AzVMwareGlobalReachConnection.md @@ -16,22 +16,23 @@ Create a global reach connection in a private cloud ``` Update-AzVMwareGlobalReachConnection -Name -PrivateCloudName -ResourceGroupName [-SubscriptionId ] [-AuthorizationKey ] [-ExpressRouteId ] - [-PeerExpressRouteCircuit ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-PeerExpressRouteCircuit ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityPrivateCloudExpanded ``` Update-AzVMwareGlobalReachConnection -Name -PrivateCloudInputObject [-AuthorizationKey ] [-ExpressRouteId ] [-PeerExpressRouteCircuit ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzVMwareGlobalReachConnection -InputObject [-AuthorizationKey ] [-ExpressRouteId ] [-PeerExpressRouteCircuit ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,24 +40,32 @@ Create a global reach connection in a private cloud ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update a global reach connection in a private cloud +```powershell Update-AzVMwareGlobalReachConnection -Name azps_test_grc -PrivateCloudName azps_test_cloud -ResourceGroupName azps_test_group ``` +```output +Name Type ResourceGroupName +---- ---- ----------------- +azps_test_grc Microsoft.AVS/privateClouds/globalReachConnections azps_test_group +``` + +Update a global reach connection in a private cloud + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -65,7 +74,7 @@ Accept wildcard characters: False Authorization key from the peer express route used for the global reach connection ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -81,7 +90,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -96,7 +105,7 @@ Accept wildcard characters: False The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -109,10 +118,9 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: IVMwareIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity Parameter Sets: UpdateViaIdentityExpanded Aliases: @@ -127,7 +135,7 @@ Accept wildcard characters: False Name of the global reach connection in the private cloud ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaIdentityPrivateCloudExpanded Aliases: GlobalReachConnectionName @@ -142,13 +150,13 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -157,7 +165,7 @@ Accept wildcard characters: False Identifier of the ExpressRoute Circuit to peer with in the global reach connection ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -170,10 +178,9 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml -Type: IVMwareIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity Parameter Sets: UpdateViaIdentityPrivateCloudExpanded Aliases: @@ -188,7 +195,7 @@ Accept wildcard characters: False The name of the private cloud. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: @@ -199,12 +206,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: @@ -219,13 +241,13 @@ Accept wildcard characters: False The ID of the target subscription. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -234,7 +256,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -250,7 +272,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -267,90 +289,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IGlobalReachConnection + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[AddonName \\]: Name of the addon for the private cloud - \[AuthorizationName \\]: Name of the ExpressRoute Circuit Authorization in the private cloud - \[CloudLinkName \\]: Name of the cloud link resource - \[ClusterName \\]: Name of the cluster in the private cloud - \[DatastoreName \\]: Name of the datastore in the private cloud cluster - \[DhcpId \\]: NSX DHCP identifier. -Generally the same as the DHCP display name - \[DnsServiceId \\]: NSX DNS Service identifier. -Generally the same as the DNS Service's display name - \[DnsZoneId \\]: NSX DNS Zone identifier. -Generally the same as the DNS Zone's display name - \[GatewayId \\]: NSX Gateway identifier. -Generally the same as the Gateway's display name - \[GlobalReachConnectionName \\]: Name of the global reach connection in the private cloud - \[HcxEnterpriseSiteName \\]: Name of the HCX Enterprise Site in the private cloud - \[Id \\]: Resource identity path - \[Location \\]: Azure region - \[PlacementPolicyName \\]: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - \[PortMirroringId \\]: NSX Port Mirroring identifier. -Generally the same as the Port Mirroring display name - \[PrivateCloudName \\]: Name of the private cloud - \[PublicIPId \\]: NSX Public IP Block identifier. -Generally the same as the Public IP Block's display name - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ScriptCmdletName \\]: Name of the script cmdlet resource in the script package in the private cloud - \[ScriptExecutionName \\]: Name of the user-invoked script execution resource - \[ScriptPackageName \\]: Name of the script package in the private cloud - \[SegmentId \\]: NSX Segment identifier. -Generally the same as the Segment's display name - \[SubscriptionId \\]: The ID of the target subscription. - \[VMGroupId \\]: NSX VM Group identifier. -Generally the same as the VM Group's display name - \[VirtualMachineId \\]: Virtual Machine identifier - \[WorkloadNetworkName \\]: Name for the workload network in the private cloud - -PRIVATECLOUDINPUTOBJECT \: Identity Parameter - \[AddonName \\]: Name of the addon for the private cloud - \[AuthorizationName \\]: Name of the ExpressRoute Circuit Authorization in the private cloud - \[CloudLinkName \\]: Name of the cloud link resource - \[ClusterName \\]: Name of the cluster in the private cloud - \[DatastoreName \\]: Name of the datastore in the private cloud cluster - \[DhcpId \\]: NSX DHCP identifier. -Generally the same as the DHCP display name - \[DnsServiceId \\]: NSX DNS Service identifier. -Generally the same as the DNS Service's display name - \[DnsZoneId \\]: NSX DNS Zone identifier. -Generally the same as the DNS Zone's display name - \[GatewayId \\]: NSX Gateway identifier. -Generally the same as the Gateway's display name - \[GlobalReachConnectionName \\]: Name of the global reach connection in the private cloud - \[HcxEnterpriseSiteName \\]: Name of the HCX Enterprise Site in the private cloud - \[Id \\]: Resource identity path - \[Location \\]: Azure region - \[PlacementPolicyName \\]: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - \[PortMirroringId \\]: NSX Port Mirroring identifier. -Generally the same as the Port Mirroring display name - \[PrivateCloudName \\]: Name of the private cloud - \[PublicIPId \\]: NSX Public IP Block identifier. -Generally the same as the Public IP Block's display name - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[ScriptCmdletName \\]: Name of the script cmdlet resource in the script package in the private cloud - \[ScriptExecutionName \\]: Name of the user-invoked script execution resource - \[ScriptPackageName \\]: Name of the script package in the private cloud - \[SegmentId \\]: NSX Segment identifier. -Generally the same as the Segment's display name - \[SubscriptionId \\]: The ID of the target subscription. - \[VMGroupId \\]: NSX VM Group identifier. -Generally the same as the VM Group's display name - \[VirtualMachineId \\]: Virtual Machine identifier - \[WorkloadNetworkName \\]: Name for the workload network in the private cloud ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.vmware/update-azvmwareglobalreachconnection](https://learn.microsoft.com/powershell/module/az.vmware/update-azvmwareglobalreachconnection) - diff --git a/src/VMware/VMware/help/Update-AzVMwarePlacementPolicy.md b/src/VMware/VMware/help/Update-AzVMwarePlacementPolicy.md index 85d93e7c86fd..22b96df6c76e 100644 --- a/src/VMware/VMware/help/Update-AzVMwarePlacementPolicy.md +++ b/src/VMware/VMware/help/Update-AzVMwarePlacementPolicy.md @@ -17,30 +17,32 @@ Update a placement policy in a private cloud cluster Update-AzVMwarePlacementPolicy -ClusterName -Name -PrivateCloudName -ResourceGroupName [-SubscriptionId ] [-AffinityStrength ] [-AzureHybridBenefitType ] [-HostMember ] [-State ] [-VMMember ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityPrivateCloudExpanded ``` Update-AzVMwarePlacementPolicy -ClusterName -Name -PrivateCloudInputObject [-AffinityStrength ] [-AzureHybridBenefitType ] [-HostMember ] [-State ] - [-VMMember ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-VMMember ] [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityClusterExpanded ``` Update-AzVMwarePlacementPolicy -Name -ClusterInputObject [-AffinityStrength ] [-AzureHybridBenefitType ] [-HostMember ] [-State ] - [-VMMember ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-VMMember ] [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzVMwarePlacementPolicy -InputObject [-AffinityStrength ] [-AzureHybridBenefitType ] [-HostMember ] [-State ] [-VMMember ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-AsJob] [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -123,7 +125,6 @@ Accept wildcard characters: False ### -ClusterInputObject Identity Parameter -To construct, see NOTES section for CLUSTERINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -153,7 +154,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -184,7 +186,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -230,7 +231,6 @@ Accept wildcard characters: False ### -PrivateCloudInputObject Identity Parameter -To construct, see NOTES section for PRIVATECLOUDINPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -259,6 +259,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -360,42 +375,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IPlacementPolicy +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IPlacementPolicy ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS diff --git a/src/VMware/VMware/help/Update-AzVMwarePrivateCloud.md b/src/VMware/VMware/help/Update-AzVMwarePrivateCloud.md index 495c63b72a04..f00bcabfd311 100644 --- a/src/VMware/VMware/help/Update-AzVMwarePrivateCloud.md +++ b/src/VMware/VMware/help/Update-AzVMwarePrivateCloud.md @@ -8,31 +8,34 @@ schema: 2.0.0 # Update-AzVMwarePrivateCloud ## SYNOPSIS -Update a private cloud +Create a private cloud ## SYNTAX ### UpdateExpanded (Default) ``` Update-AzVMwarePrivateCloud -Name -ResourceGroupName [-SubscriptionId ] - [-EncryptionStatus ] [-ExtendedNetworkBlock ] [-IdentitySource ] - [-IdentityType ] [-Internet ] [-KeyVaultPropertyKeyName ] - [-KeyVaultPropertyKeyVaultUrl ] [-KeyVaultPropertyKeyVersion ] - [-ManagementClusterHost ] [-ManagementClusterSize ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-EnableSystemAssignedIdentity ] [-EncryptionStatus ] [-ExtendedNetworkBlock ] + [-IdentitySource ] [-Internet ] [-KeyVaultPropertyKeyName ] + [-KeyVaultPropertyKeyVaultUrl ] [-KeyVaultPropertyKeyVersion ] [-Location ] + [-ManagementClusterHost ] [-ManagementClusterSize ] [-NsxtPassword ] + [-SkuName ] [-Tag ] [-VcenterPassword ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzVMwarePrivateCloud -InputObject [-EncryptionStatus ] - [-ExtendedNetworkBlock ] [-IdentitySource ] [-IdentityType ] +Update-AzVMwarePrivateCloud -InputObject [-EnableSystemAssignedIdentity ] + [-EncryptionStatus ] [-ExtendedNetworkBlock ] [-IdentitySource ] [-Internet ] [-KeyVaultPropertyKeyName ] [-KeyVaultPropertyKeyVaultUrl ] - [-KeyVaultPropertyKeyVersion ] [-ManagementClusterHost ] [-ManagementClusterSize ] - [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-KeyVaultPropertyKeyVersion ] [-Location ] [-ManagementClusterHost ] + [-ManagementClusterSize ] [-NsxtPassword ] [-SkuName ] [-Tag ] + [-VcenterPassword ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Update a private cloud +Create a private cloud ## EXAMPLES @@ -80,7 +83,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -94,11 +98,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EncryptionStatus -Status of customer managed encryption key +### -EnableSystemAssignedIdentity +Decides if enable a system assigned identity for the resource. ```yaml -Type: System.String +Type: System.Nullable`1[System.Boolean] Parameter Sets: (All) Aliases: @@ -109,13 +113,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExtendedNetworkBlock -Array of additional networks noncontiguous with networkBlock. -Networks must be unique and non-overlapping across VNet in your subscription, on-premise, and this privateCloud networkBlock attribute. -Make sure the CIDR format conforms to (A.B.C.D/X). +### -EncryptionStatus +Status of customer managed encryption key ```yaml -Type: System.String[] +Type: System.String Parameter Sets: (All) Aliases: @@ -126,12 +128,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentitySource -vCenter Single Sign On Identity Sources -To construct, see NOTES section for IDENTITYSOURCE properties and create a hash table. +### -ExtendedNetworkBlock +Array of additional networks noncontiguous with networkBlock. +Networks must be unique and non-overlapping across VNet in your subscription, on-premise, and this privateCloud networkBlock attribute. +Make sure the CIDR format conforms to (A.B.C.D/X). ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IIdentitySource[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -142,13 +145,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityType -The type of identity used for the private cloud. -The type 'SystemAssigned' refers to an implicitly created identity. -The type 'None' will remove any identities from the Private Cloud. +### -IdentitySource +vCenter Single Sign On Identity Sources ```yaml -Type: System.String +Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IIdentitySource[] Parameter Sets: (All) Aliases: @@ -161,7 +162,6 @@ Accept wildcard characters: False ### -InputObject Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IVMwareIdentity @@ -235,6 +235,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Location +Resource location + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ManagementClusterHost The hosts @@ -295,6 +310,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NsxtPassword +Optionally, set the NSX-T Manager password when the private cloud is created + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. @@ -311,6 +356,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SkuName +The name of the SKU. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SubscriptionId The ID of the target subscription. @@ -341,6 +401,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VcenterPassword +Optionally, set the vCenter admin password when the private cloud is created + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -381,54 +456,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.Api20211201.IPrivateCloud +### Microsoft.Azure.PowerShell.Cmdlets.VMware.Models.IPrivateCloud ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -`IDENTITYSOURCE `: vCenter Single Sign On Identity Sources - - `[Alias ]`: The domain's NetBIOS name - - `[BaseGroupDn ]`: The base distinguished name for groups - - `[BaseUserDn ]`: The base distinguished name for users - - `[Domain ]`: The domain's dns name - - `[Name ]`: The name of the identity source - - `[Password ]`: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. - - `[PrimaryServer ]`: Primary server URL - - `[SecondaryServer ]`: Secondary server URL - - `[Ssl ]`: Protect LDAP communication using SSL certificate (LDAPS) - - `[Username ]`: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group - -`INPUTOBJECT `: Identity Parameter - - `[AddonName ]`: Name of the addon for the private cloud - - `[AuthorizationName ]`: Name of the ExpressRoute Circuit Authorization in the private cloud - - `[CloudLinkName ]`: Name of the cloud link resource - - `[ClusterName ]`: Name of the cluster in the private cloud - - `[DatastoreName ]`: Name of the datastore in the private cloud cluster - - `[DhcpId ]`: NSX DHCP identifier. Generally the same as the DHCP display name - - `[DnsServiceId ]`: NSX DNS Service identifier. Generally the same as the DNS Service's display name - - `[DnsZoneId ]`: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name - - `[GatewayId ]`: NSX Gateway identifier. Generally the same as the Gateway's display name - - `[GlobalReachConnectionName ]`: Name of the global reach connection in the private cloud - - `[HcxEnterpriseSiteName ]`: Name of the HCX Enterprise Site in the private cloud - - `[Id ]`: Resource identity path - - `[Location ]`: Azure region - - `[PlacementPolicyName ]`: Name of the VMware vSphere Distributed Resource Scheduler (DRS) placement policy - - `[PortMirroringId ]`: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name - - `[PrivateCloudName ]`: Name of the private cloud - - `[PublicIPId ]`: NSX Public IP Block identifier. Generally the same as the Public IP Block's display name - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[ScriptCmdletName ]`: Name of the script cmdlet resource in the script package in the private cloud - - `[ScriptExecutionName ]`: Name of the user-invoked script execution resource - - `[ScriptPackageName ]`: Name of the script package in the private cloud - - `[SegmentId ]`: NSX Segment identifier. Generally the same as the Segment's display name - - `[SubscriptionId ]`: The ID of the target subscription. - - `[VMGroupId ]`: NSX VM Group identifier. Generally the same as the VM Group's display name - - `[VirtualMachineId ]`: Virtual Machine identifier - ## RELATED LINKS